google-genomics1 库允许访问 Google 基因组服务的所有功能。

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

关于 genomics v1 API 的其他内容，请参阅 官方文档网站。

特性

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

• 操作
• 取消，获取 和 列表

此库的结构

API 被结构化为以下主要项目

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

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

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

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

或具体地 ...

let r = hub.operations().cancel(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await

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

使用方法

设置您的项目

要使用此库，您需要在您的 Cargo.toml 文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_genomics1 as genomics1;
use genomics1::{Result, Error};
use std::default::Default;
use genomics1::{Genomics, 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 = Genomics::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.operations().list("name")
             .page_token("magna")
             .page_size(-11)
             .filter("ipsum")
             .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")。

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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