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

本文档由 genomics 库版本 0.1.8+20150326 生成，其中 20150326 是由 mako 代码生成器 v0.1.8 构建的 genomics:v1beta2 模式的确切修订版本。

有关 genomics v1_beta2 API 的其他所有信息，请参阅 官方文档网站。

特性

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

• 注释集
• 创建、删除、获取、修补、搜索 和 更新
• 注释
• 批量创建、创建、删除、获取、修补、搜索 和 更新
• 调用集
• 创建，删除，获取，修补，搜索 和 更新
• 数据集
• 创建，删除，获取，列表，修补，恢复删除 和 更新
• 实验性
• 作业创建
• 作业
• 取消，获取 和 搜索
• 读取组集
• 对齐，调用，覆盖桶列表，删除，导出，获取，导入，修补，搜索 和 更新
• 读取
• 搜索
• 参考
• 基础列表，获取 和 搜索
• 参考集
• 获取 和 搜索
• 流式读取存储
• 流式读取
• 变体
• 创建，删除，获取，搜索 和 更新
• 变体集
• 删除、导出、获取、导入变异体、合并变异体、修补、搜索和更新

库的结构

API结构为以下主要元素

• 枢纽
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，后者又允许访问单个调用构建器
• 资源
  • 你可以将其应用于活动的主要类型
  • 属性和部分的集合
  • 部分
    • 属性集合
    • 永远不会在活动中直接使用
• 活动
  • 应用于资源的操作

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

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

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

或者具体...

let r = hub.annotations().search(...).doit()
let r = hub.annotations().patch(...).doit()
let r = hub.annotations().create(...).doit()
let r = hub.annotations().delete(...).doit()
let r = hub.annotations().update(...).doit()
let r = hub.annotations().get(...).doit()
let r = hub.annotations().batch_create(...).doit()

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

使用方法

设置您的项目

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

[dependencies]
google-genomics1_beta2 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_genomics1_beta2 as genomics1_beta2;
use genomics1_beta2::Annotation;
use genomics1_beta2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use genomics1_beta2::Genomics;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Genomics::new(hyper::Client::new(), 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 = Annotation::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.annotations().patch(req, "annotationId")
             .doit();

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::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。

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

上传和下载

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

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

许可

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