45个版本 (28个稳定版本)
5.0.5+20240624 | 2024年6月27日 |
---|---|
5.0.4+20240304 | 2024年3月5日 |
5.0.3+20230120 | 2023年8月23日 |
5.0.2+20230120 | 2023年3月16日 |
0.1.2+20150222 | 2015年3月25日 |
#2 in #fitness
50 每月下载量
在 google-fitness1-cli 中使用
320KB
4K SLoC
google-fitness1
库允许访问 Google 健身服务的所有功能。
本文档是从 fitness 包版本 5.0.5+20240624 生成的,其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 fitness:v1 模式的确切修订。
有关 fitness v1 API 的其他所有信息,请参阅 官方文档网站。
功能
从中心 枢纽 简单地处理以下 资源 ...
- 用户
- 创建数据源, 数据源数据点更改列表, 删除数据源数据集, 获取数据源数据集, 更新数据源数据集, 删除数据源, 获取数据源, 列出数据源, 更新数据源, 数据集聚合, 删除会话, 列出会话 和 更新会话
此库的结构
API 结构如下主要项目
所有 结构 都带有适用的特性,以便进一步分类并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体来说 ...
let r = hub.users().data_sources_create(...).doit().await
let r = hub.users().data_sources_delete(...).doit().await
let r = hub.users().data_sources_get(...).doit().await
let r = hub.users().data_sources_update(...).doit().await
resource()
和 activity(...)
调用创建 构建器。第二个处理 活动
支持各种方法来配置即将进行的操作(此处未显示)。它设计得使得所有必需的参数都必须立即指定(即 (...)
),而所有可选的参数则可以按需 构建。doit()
方法执行与服务器实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-fitness1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_fitness1 as fitness1;
use fitness1::api::DataSource;
use fitness1::{Result, Error};
use std::default::Default;
use fitness1::{Fitness, 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 = Fitness::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 = DataSource::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.users().data_sources_update(req, "userId", "dataSourceId")
.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()
之前,为 Method Builder 提供一个 代理 来更改 doit()
方法的调用方式。相关方法将被调用以提供进度信息,以及确定系统在失败时是否应该重试。
代理 trait 默认实现,让您可以以最小的努力对其进行自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过 json 进行编码和解码,以便 encodable 和 decodable。选项用于表示部分请求或响应是有效的。大多数选项都是可识别的 Parts,它们通过名称标识,将发送到服务器以指示请求的设置部分或响应中所需的部分。
构建器参数
通过使用 方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受一个单一参数,以下语句为真。
参数将始终被复制或克隆到构建器中,以便使它们与其原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将是无效的。
许可证
由 Sebastian Thiel 生成的 fitness1 库,置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~341K SLoC