8个版本 (稳定版)
5.0.5+20240626 | 2024年6月27日 |
---|---|
5.0.4+20240303 | 2024年3月5日 |
5.0.3+20230123 | 2023年8月23日 |
5.0.2+20230123 | 2023年3月16日 |
3.0.0+20220305 | 2022年3月8日 |
在 Web编程 中排名 2677
每月下载量 469
在 google-fcmdata1_beta1-cli 中使用
115KB
1.5K SLoC
google-fcmdata1_beta1
库允许访问Google Fcmdata服务的所有功能。
本文档由 Fcmdata 包版本 5.0.5+20240626 生成,其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 fcmdata:v1beta1 架构的确切修订版。
关于Fcmdata v1_beta1 API的其他信息可以在 官方文档网站 上找到。
功能
从中央 枢纽 简单地处理以下 资源...
库的结构
API结构如下主要项
所有 结构 都带有适用特性,以便进一步分类并便于浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体...
let r = hub.projects().android_apps_delivery_data_list(...).doit().await
资源 resource()
和活动 activity(...)
调用创建 构建器。第二个处理 Activities
,支持配置即将进行的操作的各种方法(此处未显示)。它被设计成必须立即指定所有必需参数(即 (...)
),而所有可选参数则可以按需 构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-fcmdata1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_fcmdata1_beta1 as fcmdata1_beta1;
use fcmdata1_beta1::{Result, Error};
use std::default::Default;
use fcmdata1_beta1::{Fcmdata, 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 = Fcmdata::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.projects().android_apps_delivery_data_list("parent")
.page_token("magna")
.page_size(-11)
.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(...)
。
自定义和回调
您可以通过向 Method Builder 提供一个 delegate 来修改 doit()
方法的调用方式,在执行最终的 doit()
调用之前。相应的方 法将被调用以提供进度信息,并确定系统在失败时是否应该重试。
delegate trait 具有默认实现,允许您以最少的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都是为了通过json进行编码和解码而设计的。可选参数用于表示部分请求或响应是有效的。大多数可选参数被认为是部分,可以通过名称识别,这些部分将被发送到服务器以指示请求或响应中期望的部分。
构建器参数
通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受一个参数,以下语句适用于该参数。
参数将始终被复制或克隆到构建器中,以使其与其原始生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并从所有类型中推导出utoipa::ToSchema
。您需要在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将是无效的。
许可证
fcmdata1_beta1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖关系
~12-22MB
~341K SLoC