20个稳定版本 (4个主要版本)

5.0.5+20240621 2024年6月27日
5.0.4+20240227 2024年3月5日
5.0.3+20230119 2023年8月24日
5.0.2+20230119 2023年3月17日
1.0.6+20170922 2017年9月27日

#2571 in Web编程

Download history 3/week @ 2024-05-18 1/week @ 2024-05-25 1/week @ 2024-06-08 100/week @ 2024-06-22 20/week @ 2024-06-29 65/week @ 2024-07-06

每月下载量 67次
google-testing1-cli 中使用

MIT 许可证

325KB
4K SLoC

google-testing1 库允许访问 Google 测试服务的所有功能。

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

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

功能

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

本库的结构

API 被组织成以下主要项

  • 枢纽
  • 资源
    • 主要类型,您可以将其应用于 活动
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

所有结构都带有相应的特征,以便进一步分类和便于浏览。

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

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

或者具体...

let r = hub.projects().device_sessions_create(...).doit().await
let r = hub.projects().device_sessions_get(...).doit().await
let r = hub.projects().device_sessions_patch(...).doit().await

以下代码resource()activity(...)创建构建器。第二个处理Activities支持各种方法来配置即将进行的操作(此处未显示)。它是这样设计的,即必须立即指定所有必需的参数(即(...)),而所有可选的参数可以按需构建doit()方法执行与服务器实际通信并返回相应的结果。

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_testing1 as testing1;
use testing1::api::DeviceSession;
use testing1::{Result, Error};
use std::default::Default;
use testing1::{Testing, 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 = Testing::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 = DeviceSession::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.projects().device_sessions_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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),
}

处理错误

系统产生的所有错误都作为(...)枚举返回值提供,或者作为可能的中继结果传递给(...)Hub Delegate,或Authenticator Delegate

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

上传和下载

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

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

自定义和回调

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

默认实现了代理特质,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可

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

依赖

~12–23MB
~344K SLoC