8 个版本 (稳定)
5.0.5+20240625 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20240303 | 2024 年 3 月 5 日 |
5.0.3+20230123 | 2023 年 8 月 24 日 |
5.0.2+20230123 | 2023 年 3 月 17 日 |
3.0.0+20220307 | 2022 年 3 月 8 日 |
#2589 in Web 编程
每月 459 次下载
用于 google-versionhistory1-cl…
145KB
2K SLoC
google-versionhistory1
库允许访问 Google 版本历史服务的所有功能。
本文档是从 版本历史 crate 版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 versionhistory:v1 模式的确切修订版本。
有关 版本历史 v1 API 的其他所有信息,请参阅 官方文档网站。
功能
轻松从中央 中心 处理以下 资源...
本库的结构
API 被结构化为以下主要项目
所有 结构 都带有适用的特征标记,以便进一步分类并简化浏览。
一般来说,您可以通过以下方式调用 活动
let r = hub.resource().activity(...).doit().await
或具体地说...
let r = hub.platforms().channels_versions_releases_list(...).doit().await
let r = hub.platforms().channels_versions_list(...).doit().await
let r = hub.platforms().channels_list(...).doit().await
let r = hub.platforms().list(...).doit().await
资源(resource)和活动(activity)调用创建构建器。第二个调用处理活动(Activities),支持配置即将进行的操作的各种方法(此处未展示)。它被设计成必须立即指定所有必需参数(即(...)
),而所有可选的都可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
使用方法
设置项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-versionhistory1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_versionhistory1 as versionhistory1;
use versionhistory1::{Result, Error};
use std::default::Default;
use versionhistory1::{VersionHistory, 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 = VersionHistory::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.platforms().channels_versions_releases_list("parent")
.page_token("magna")
.page_size(-11)
.order_by("ipsum")
.filter("voluptua.")
.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(...)
。
自定义和回调
您可以通过向doit()
方法提供代理来更改在最终调用doit()
之前的方式。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。
代理特质默认实现,允许您以最小努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都是为了能够通过 编码 和 解码 以 json 格式进行设计的。使用可选参数来表示部分请求或响应是有效的。大多数可选参数都是 Parts,它们可以通过名称识别,并将发送到服务器以指示请求的集合部分或响应中所需的部分。
构建器参数
通过使用 方法构建器,您可以重复调用其方法来准备一个动作调用。这些方法总是接受一个参数,以下语句适用于该参数。
参数将始终被复制或克隆到构建器中,以确保它们与其原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上推导出utoipa::ToSchema
。您需要在#[openapi(schemas(...))]
中导入并注册所需类型,否则生成的openapi
规范将是无效的。
许可证
versionhistory1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–23MB
~343K SLoC