该 google-mirror1 库允许访问 Google 镜像服务的所有功能。

此文档是根据 mirror crate 版本 5.0.5+20190424 生成的，其中 20190424 是由 mako 代码生成器 v5.0.5 构建的 mirror:v1 架构的确切修订版本。

关于 mirror v1 API 的其他所有信息可以在 官方文档网站 上找到。

功能

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

• 账户
• 插入
• 联系人
• 删除、获取、插入、列出、修补 和 更新
• 位置
• 获取 和 列出
• 设置
• 获取
• 订阅
• 删除、插入、列出 和 更新
• 时间线
• 附件删除，附件获取，附件插入，附件列表，删除，获取，插入，列表，修补和更新

支持由 ... 上传

• 附件插入时间线
• 插入时间线
• 更新时间线

支持由 ... 下载

• 附件获取时间线

此库的结构

API结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器反过来允许访问单个 调用构建器
• 资源
  • 主要类型，您可以将其应用于 活动
  • 属性和 部分 的集合
  • 部分
    • 属性集合
    • 永远不会在 活动 中直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用特性，以进一步分类它们并便于浏览。

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

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

或具体...

let r = hub.contacts().delete(...).doit().await
let r = hub.contacts().get(...).doit().await
let r = hub.contacts().insert(...).doit().await
let r = hub.contacts().list(...).doit().await
let r = hub.contacts().patch(...).doit().await
let r = hub.contacts().update(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mirror1 as mirror1;
use mirror1::api::Contact;
use mirror1::{Result, Error};
use std::default::Default;
use mirror1::{Mirror, 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 = Mirror::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Contact::default();

// 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.contacts().patch(req, "id")
             .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 Delegate，或Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统对各种错误具有潜在的抗性。

上传和下载

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

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

定制和回调

您可以通过在最终调用doit()之前将一个代理提供给方法构建器来改变doit()方法的调用方式。相应的方法将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

代理特质默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都是为了通过json进行编码和解码而设计的。使用可选值来表示部分请求或响应是有效的。大多数可选值都是被认为是部分，这些部分可以通过名称识别，并将发送到服务器以指示请求中设置的部分或响应中所需的部分。

构建器参数

使用方法构建器，您可以通过反复调用它的方法来准备一个操作调用。这些方法始终只接受一个参数，以下语句对于该参数是真实的。

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

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

Cargo功能

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

许可证

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