6个版本
使用旧的 Rust 2015
0.1.5+20150114 | 2015年4月8日 |
---|---|
0.1.4+20150114 | 2015年4月7日 |
0.1.2+20150114 | 2015年3月25日 |
#54 in #api-version
52 每月下载量
175KB
2K SLoC
google-dns1_beta1
库允许访问 Google dns 服务的所有功能。
此文档是从 dns crate 版本 0.1.5+20150114 生成的,其中 20150114 是由 mako 代码生成器 v0.1.5 构建的 dns:v1beta1 架构的确切修订版本。
有关 dns v1_beta1 API 的其他所有信息,请参阅 官方文档网站。
功能
从中心 枢纽 轻松处理以下 资源...
本库的结构
API 结构如下
所有 结构 都带有适用的特性,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit()
或者具体...
let r = hub.managed_zones().get(...).doit()
let r = hub.managed_zones().list(...).doit()
let r = hub.managed_zones().create(...).doit()
let r = hub.managed_zones().delete(...).doit()
资源(resource)和活动(activity)调用创建构建器。第二个调用处理活动(Activities),支持配置即将进行的操作的各种方法(此处未显示)。它设计成必须立即指定所有必需的参数(即 (...)
),而所有可选的都可以按需构建。doit()
方法执行与服务器实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-dns1_beta1 = "*"
完整示例
extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_dns1_beta1 as dns1_beta1;
use dns1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dns1_beta1::Dns;
// 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 = Dns::new(hyper::Client::new(), 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.managed_zones().list("project")
.page_token("sit")
.max_results(-65)
.doit();
match result {
Err(e) => match e {
Error::HttpError(err) => println!("HTTPERROR: {:?}", err),
Error::MissingAPIKey => println!("Auth: Missing API Key - used if there are no scopes"),
Error::MissingToken => println!("OAuth2: Missing Token"),
Error::Cancelled => println!("Operation canceled by user"),
Error::UploadSizeLimitExceeded(size, max_size) => println!("Upload size too big: {} of {}", size, max_size),
Error::Failure(_) => println!("General Failure (hyper::client::Response doesn't print)"),
Error::FieldClash(clashed_field) => println!("You added custom parameter which is part of builder: {:?}", clashed_field),
Error::JsonDecodeError(err) => println!("Couldn't understand server reply - maybe API needs update: {:?}", err),
},
Ok(_) => println!("Success (value doesn't print)"),
}
处理错误
系统产生的所有错误都作为(...)
方法的返回值提供的Result枚举,或者作为可能的中继结果传递给Hub Delegate或Authenticator Delegate。
当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。
上传和下载
如果方法支持下载,应该由您读取响应体以获取媒体,该响应体是Result的一部分。如果此类方法还支持Response Result,它将默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用多达2种不同的协议进行上传:简单和可恢复。每种协议的独特性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过向Method Builder提供代理并在最终调用doit()
之前来更改调用doit()
方法的方式。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。
delegate trait具有默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了通过 编码 和 解码 为 json 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 部分,这些部分可以通过名称识别,并将被发送到服务器以指示请求的集合部分或响应中期望的部分。
构建器参数
使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受单个参数,以下陈述对它适用。
参数将始终被复制或克隆到构建器中,以便它们与它们的原始生命周期独立。
许可
由 Sebastian Thiel 生成的 dns1_beta1 库,并置于 MIT 许可之下。您可以在存储库的 许可文件 中阅读全文。
依赖项
~18–29MB
~544K SLoC