该 google-verifiedaccess1 库允许访问 Google verifiedaccess 服务所有功能。

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

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

特性

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

• 挑战
• 创建 和 验证

本库的结构

API 被结构化为以下主要元素

• 枢纽
  • 维护状态并允许访问所有 活动 的中心对象
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 可以应用 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

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

通常，您可以像这样调用 活动

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

或者具体...

let r = hub.challenge().verify(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_verifiedaccess1 as verifiedaccess1;
use verifiedaccess1::api::VerifyChallengeResponseRequest;
use verifiedaccess1::{Result, Error};
use std::default::Default;
use verifiedaccess1::{Verifiedaccess, 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 = Verifiedaccess::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 = VerifyChallengeResponseRequest::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.challenge().verify(req)
             .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。

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

上传和下载

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

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

定制和回调

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

委托特剧行为默认实现，允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是为了能够通过 编码 和 解码 JSON 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 部分，可以通过名称识别，这些部分将被发送到服务器，以指示请求的设置部分或期望的响应部分。

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受一个参数，以下陈述对此参数成立。

• POD 以复制方式传递
• 字符串作为 &str 传递
• 请求值 被移动

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

Cargo 功能

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

许可证

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