37 个版本 (稳定版)

5.0.5+20200806 2024 年 6 月 27 日
5.0.4+20200806 2024 年 3 月 5 日
5.0.3+20200806 2023 年 8 月 23 日
5.0.2+20200806 2023 年 3 月 16 日
0.1.8+00000000 2015 年 6 月 19 日

#5#discovery 类别中

Download history 5/week @ 2024-05-17 2/week @ 2024-05-24 1/week @ 2024-06-07 66/week @ 2024-06-21 32/week @ 2024-06-28 1/week @ 2024-07-05

2,168 每月下载量
google-discovery1-cli 中使用

MIT 许可证

130KB
2K SLoC

google-discovery1 库允许访问 Google 发现服务的所有功能。

本文档是从 discovery crate 版本 5.0.5+20200806 生成的,其中 20200806 是由 mako 代码生成器 v5.0.5 构建的 discovery:v1 架构的确切修订版本。

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

功能

从中心 枢纽 简单地处理以下 资源...

库的结构

API 被组织成以下主要项目

  • 枢纽
  • 资源
    • 可以应用 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 从未在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体...

let r = hub.apis().get_rest(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_discovery1 as discovery1;
use discovery1::{Result, Error};
use std::default::Default;
use discovery1::{Discovery, 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 = Discovery::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 `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.apis().get_rest("api", "version")
             .doit().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")

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

自定义和回调

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

delegate trait具有默认实现,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是为了能够通过 编码解码 通过 json。使用可选值来表示部分请求或响应是有效的。大多数可选值都是被视为 Parts,这些可以通过名称识别,将它们发送到服务器以指示请求的集合部分或响应中期望的部分。

构建器参数

通过使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受一个参数,以下陈述适用于该参数。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~345K SLoC