#google-api #google #protocols #web-api #api #web #fusiontables

google-fusiontables2

用于与 fusiontables(协议 v2)交互的完整库

44 个版本 (27 个稳定版本)

5.0.5+20171117 2024 年 6 月 27 日
5.0.4+20171117 2024 年 3 月 5 日
5.0.3+20171117 2023 年 8 月 23 日
5.0.2+20171117 2023 年 3 月 16 日
0.1.2+20150226 2015 年 3 月 25 日

#2294网页编程


用于 google-fusiontables2-cli

MIT 许可证

585KB
7.5K SLoC

google-fusiontables2 库允许访问 Google fusiontables 服务的所有功能。

本文档是从 fusiontables 包版本 5.0.5+20171117 生成的,其中 20171117 是由 mako 代码生成器 v5.0.5 构建的 fusiontables:v2 模式的确切修订。

有关 fusiontables v2 API 的其他所有信息,请参阅 官方文档网站

特性

从中心 枢纽 轻松处理以下 资源...

由 ... 支持的上传

由 ... 支持的下载

此库的结构

API结构如下主要项

  • 中心
  • 资源
    • 你可以应用 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从不直接用于 活动
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用的特性,以进一步分类它们并简化浏览。

一般来说,你可以这样调用 活动

let r = hub.resource().activity(...).doit().await

或具体 ...

let r = hub.table().copy(...).doit().await
let r = hub.table().get(...).doit().await
let r = hub.table().import_table(...).doit().await
let r = hub.table().insert(...).doit().await
let r = hub.table().patch(...).doit().await
let r = hub.table().update(...).doit().await

resource()activity(...) 调用创建 构建器。第二个处理 活动,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需的参数(即 (...)),而所有可选的参数都可以按需 构建doit() 方法执行与服务器实际通信,并返回相应的结果。

用法

设置你的项目

要使用此库,你将在你的 Cargo.toml 文件中放入以下行

[dependencies]
google-fusiontables2 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_fusiontables2 as fusiontables2;
use fusiontables2::{Result, Error};
use std::fs;
use std::default::Default;
use fusiontables2::{Fusiontables, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Fusiontables::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload(...)`.
// Values shown here are possibly random and not representative !
let result = hub.table().import_table("name")
             .encoding("magna")
             .delimiter("no")
             .upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为Result枚举提供,作为doit()方法的返回值,或者作为可能的中继结果传递给Hub DelegateAuthenticator Delegate

当委托处理错误或中继值时,它们有机会指示系统重试。这使得系统对各种错误具有潜在的鲁棒性。

上传和下载

如果一个方法支持下载,响应体,作为Result的一部分,应由您读取以获取媒体。如果此类方法还支持Response Result,它将默认返回。您可以将其视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种的独特性由定制的doit(...)方法表示,然后分别命名为upload(...)upload_resumable(...)

定制和回调

您可以通过在最终doit()调用之前向Method Builder()提供委托来更改调用doit()方法的方式。相应的方法将被调用以提供进度信息,并确定系统是否在失败时应该重试。

delegate trait具有默认实现,允许您以最少的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都是为了通过json进行编码解码而设计的。可选项用于表示部分请求或响应是有效的。大多数可选项都是被视为Parts,可按名称识别,将发送到服务器以指示请求的设置部分或响应中希望包含的部分。

构建器参数

使用方法构建器,您可以通过反复调用其方法来准备动作调用。这些方法将始终接受单个参数,以下语句是真实的。

  • PODs通过复制传递
  • 字符串作为 &str 传递。
  • 请求值会被移动。

参数将始终被复制或克隆到构建器中,以确保它们与原始生命周期独立。

Cargo 特性

  • utoipa - 添加对 utoipa 的支持,并为所有类型推导出 utoipa::ToSchema。您需要在 #[openapi(schemas(...))] 中导入和注册所需的类型,否则生成的 openapi 规范将是无效的。

许可证

fusiontables2 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。

依赖项

约 12-23MB
约 345K SLoC