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

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

功能

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

• statscollection
• updateaggregatedstats 和 updatestats

此库的结构

API 被组织成以下主要项目

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

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

一般来说，您可以通过这种方式调用 活动

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

或具体 ...

let r = hub.statscollection().updatestats(...).doit().await

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

使用方法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudlatencytest2 as cloudlatencytest2;
use cloudlatencytest2::api::Stats;
use cloudlatencytest2::{Result, Error};
use std::default::Default;
use cloudlatencytest2::{Cloudlatencytest, 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 = Cloudlatencytest::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 = Stats::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.statscollection().updatestats(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() 之前。相应的方法将被调用来提供进度信息，并确定系统在失败时应否重试。

委托特质（delegate trait）默认实现，让您可以以最少的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是Parts，这些部分可以通过名称识别，并将发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

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

• PODs（简单数据结构）通过复制传递
• 字符串作为&str传递
• 请求值是移动的

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

Cargo功能

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

许可证

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