28 个版本 (稳定版)
5.0.5+20240621 | 2024年6月27日 |
---|---|
5.0.4+20240223 | 2024年3月5日 |
5.0.3+20230112 | 2023年8月23日 |
5.0.2+20230112 | 2023年3月16日 |
0.1.9+20150825 | 2015年10月19日 |
在 网页编程 中排名第 2319
每月下载量 1,639
在 google-cloudtrace1-cli 中使用
140KB
2K SLoC
google-cloudtrace1
库允许访问 Google Cloud Trace 服务(协议 v1)的所有功能。
此文档是从 Cloud Trace crate 版本 5.0.5+20240621 生成的,其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 cloudtrace:v1 架构的确切修订版本。
有关 Cloud Trace v1 API 的其他信息,请参阅 官方文档站点。
功能
从中心 枢纽 轻松处理以下 资源...
库结构
API 被结构化为以下主要项
所有 结构 都用适用特性标记,以进一步分类它们并简化浏览。
一般来说,你可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体来说...
let r = hub.projects().traces_get(...).doit().await
资源(resource)和活动(activity)调用创建了构建器。第二个调用处理Activities
,支持各种配置即将进行的操作的方法(此处未显示)。它被设计成所有必需的参数都必须立即指定(即(...)
),而所有可选参数都可以根据需要构建。doit()
方法执行与服务器的实际通信,并返回相应的结果。
用法
设置你的项目
要使用此库,请将以下行放入您的Cargo.toml
文件中
[dependencies]
google-cloudtrace1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudtrace1 as cloudtrace1;
use cloudtrace1::{Result, Error};
use std::default::Default;
use cloudtrace1::{CloudTrace, 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 = CloudTrace::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().traces_get("projectId", "traceId")
.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(...)
。
定制和回调
您可以通过向Method Builder提供一个代理来更改doit()
方法的调用方式,然后在执行最终的doit()
调用之前。相应的方法将被调用以提供进度信息,并确定系统是否在失败时应该重试。
delegate trait默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
本库中提供的所有结构都是为了通过json进行编码和解码而设计的。编码和解码。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被认为是部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求或响应中所需的各个部分。
构建器参数
通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述适用于这些参数。
参数将始终被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并从所有类型派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
云trace1库是由Sebastian Thiel生成的,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖关系
~12–23MB
~344K SLoC