45个版本 (27个稳定版)
5.0.5+20220614 | 2024年6月27日 |
---|---|
5.0.4+20220614 | 2024年3月5日 |
5.0.3+20220614 | 2023年8月23日 |
5.0.2+20220614 | 2023年3月16日 |
0.1.2+20140428 | 2015年3月25日 |
44 在 #协议
2,642 每月下载量
用于 google-groupssettings1-cl…
150KB
2K SLoC
该 google-groupssettings1
库允许访问 Google groupssettings 服务的所有功能。
此文档是从 groupssettings 框架版本 5.0.5+20220614 生成的,其中 20220614 是由 mako 代码生成器 v5.0.5 构建的 groupssettings:v1 架构的确切修订。
有关 groupssettings v1 API 的其他信息,请参阅 官方文档网站。
功能
轻松从中央 中心 处理以下 资源 ...
此库的结构
API 被组织成以下主要项目
所有 结构 都带有适用的特质,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体地 ...
let r = hub.groups().get(...).doit().await
let r = hub.groups().patch(...).doit().await
let r = hub.groups().update(...).doit().await
资源()
和 活动(...)
调用创建了构建器。后者处理 活动
,支持配置即将进行的操作的各种方法(此处未显示)。它设计得让所有必需的参数都必须立即指定(即 (...)
),而所有可选参数则可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
使用方法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-groupssettings1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_groupssettings1 as groupssettings1;
use groupssettings1::api::Groups;
use groupssettings1::{Result, Error};
use std::default::Default;
use groupssettings1::{Groupssettings, 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 = Groupssettings::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 = Groups::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.groups().patch(req, "groupUniqueId")
.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(...)
。
自定义和回调
您可以通过向 Method Builder 提供一个 代理 来改变 doit()
方法的调用方式,在执行最后的 doit()
调用之前。相应的方法将被调用以提供进度信息,并确定系统在失败时应否重试。
代理 trait 有默认实现,允许您以最少的努力进行自定义。
服务器请求中的可选部分
本库中提供的所有结构都是设计为可以通过 编码 和 解码 来通过 json。使用可选类型来表示部分请求和响应是有效的。大多数可选类型都是 Parts,可以通过名称识别,这些将发送到服务器以指示请求中设置的部件或响应中期望的部件。
构建器参数
通过使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对此适用。
参数将始终复制或克隆到构建器中,以使它们与其原始生命周期独立。
Cargo 特性
utoipa
- 添加对 utoipa 的支持,并从所有类型中派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将是无效的。
许可证
groupssettings1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–23MB
~345K SLoC