google-appstate1 库允许访问 Google App State 服务（协议 v1）的所有功能。

本文档由 App State crate 版本 5.0.5+20190627 生成，其中 20190627 是由 mako 代码生成器 v5.0.5 构建的 appstate:v1 架构的确切修订版本。

有关 App State v1 API 的其他信息，请参阅官方文档网站。

功能

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

• 状态
• clear、delete、get、list 和 update

库的结构

API 被组织成以下主要项目

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

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

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

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

或具体...

let r = hub.states().clear(...).doit().await
let r = hub.states().update(...).doit().await

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

用法

设置项目

要使用这个库，你需要在你的Cargo.toml文件中添加以下行

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_appstate1 as appstate1;
use appstate1::api::UpdateRequest;
use appstate1::{Result, Error};
use std::default::Default;
use appstate1::{AppState, 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 = AppState::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 = UpdateRequest::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.states().update(req, -22)
             .current_state_version("magna")
             .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枚举返回值提供，或者作为可能的中途结果传递给Hub Delegate，或者Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

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

支持上传的方法可以使用最多两种不同的协议进行：简单和可恢复。每种方法的特点是通过自定义的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下语句适用于这些参数。

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

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

Cargo 功能

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

许可证

appstate1 库由 Sebastian Thiel 创建，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。