18 个稳定版本 (4 个主要版本)
5.0.5+20240623 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20240224 | 2024 年 3 月 5 日 |
5.0.3+20230118 | 2023 年 8 月 23 日 |
5.0.2+20230118 | 2023 年 3 月 16 日 |
1.0.8+20181003 | 2018 年 10 月 14 日 |
#2799 in 网页编程
每月下载量 56
用于 google-iap1_beta1-cli
150KB
2K SLoC
google-iap1_beta1
库允许访问 Google Cloud IAP(协议 v1beta1)的所有功能。
本文档由 Cloud IAP crate 版本 5.0.5+20240623 生成,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 iap:v1beta1 架构的精确版本。
有关 Cloud IAP v1_beta1 API 的其他所有信息,请参阅官方文档网站。
特性
从中心 枢纽 无需努力使用以下功能 ...
本库结构
API 被结构化为主以下项
所有 结构 都带有适用的特质,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体来说 ...
let r = hub.methods().get_iam_policy(...).doit().await
let r = hub.methods().set_iam_policy(...).doit().await
资源(resource)和活动(activity)调用创建了构建器。第二个处理Activities
的调用支持各种配置即将进行的操作的方法(此处未显示)。它被设计成必须立即指定所有必需的参数(即(...)
),而所有可选的则可以按需构建。doit()
方法执行与服务器实际通信,并返回相应的结果。
用法
设置项目
要使用此库,您需要在您的Cargo.toml
文件中添加以下行
[dependencies]
google-iap1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_iap1_beta1 as iap1_beta1;
use iap1_beta1::api::GetIamPolicyRequest;
use iap1_beta1::{Result, Error};
use std::default::Default;
use iap1_beta1::{CloudIAP, 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 = CloudIAP::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 = GetIamPolicyRequest::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.methods().get_iam_policy(req, "resource")
.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
枚举的返回值提供,或者作为可能的中间结果传递给Hub Delegate
,或Authenticator Delegate
。
当代理处理错误或中间值时,它们可能会有机会指导系统重试。这使得系统可能对所有类型的错误都具有弹性。
上传和下载
如果方法支持下载,则响应体(它是Result的一部分)应由您读取以获取媒体。如果此方法还支持Response Result,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多2种不同的协议:简单和可恢复。每种方法的独特性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过在最终调用doit()
之前向Method Builder
提供一个delegate
来更改调用doit()
方法的方式。相应的方法将被调用来提供进度信息,以及确定系统在失败时是否应该重试。
默认实现了 委托特质,允许您以最小的努力对其进行自定义。
服务器请求中的可选部分
本库提供的所有结构都是为通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是被视为 部分 的,可以通过名称识别,这些部分将被发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
通过使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法总是接受单个参数,以下陈述对它适用。
参数将始终被复制或克隆到构建器中,以确保它们与其原始生命周期独立。
Cargo 特性
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入并注册所需类型,否则生成的openapi
规范将是无效的。
许可证
iap1_beta1 库是由 Sebastian Thiel 生成的,并置于 MIT 许可证之下。您可以在仓库的 许可证文件 中阅读全文。
依赖关系
~12–22MB
~342K SLoC