48个版本 (30个稳定版)
5.0.5+20240618 | 2024年6月27日 |
---|---|
5.0.4+20240227 | 2024年3月5日 |
5.0.3+20230115 | 2023年8月23日 |
5.0.2+20230115 | 2023年3月16日 |
0.1.2+20150108 | 2015年3月25日 |
#740 在 认证
1.5MB
17K SLoC
该 google-drive2
库允许访问Google drive服务的所有功能。
此文档是从drive crate版本5.0.5+20240618生成的,其中20240618是mako代码生成器v5.0.5构建的drive:v2架构的确切修订版。
关于drive v2 API的其他信息可以在官方文档网站找到。
功能
从中央中心轻松处理以下资源...
- about
- get
- apps
- get 和 list
- changes
- get、获取起始页令牌、list 和 watch
- channels
- stop
- children
- delete、get、insert 和 list
- comments
- delete、get、insert、list、patch 和 update
- drives
- 删除,获取,隐藏,插入,列出,取消隐藏和更新
- 文件
- 复制,删除,清空回收站,导出,生成ID,获取,插入,列出,列出标签,修改标签,修补,接触,移动到回收站,从回收站还原,更新和监控
- 父级
- 删除,获取,插入和列出
- 权限
- 删除,获取,根据电子邮件获取ID,插入,列出,修补和更新
- 属性
- 删除,获取,插入,列出,修补和更新
- 回复
- 删除,获取,插入,列出,修补和更新
- 修订版
- 删除、获取、列表、修补和更新
- 团队驱动
- 删除、获取、插入、列表和更新
由...支持的上传
由...支持的下载数据
由...支持的订阅
本库的结构
API 结构为以下主要项目
所有 结构 都标有适用的特性和,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体来说...
let r = hub.files().copy(...).doit().await
let r = hub.files().delete(...).doit().await
let r = hub.files().empty_trash(...).doit().await
let r = hub.files().export(...).doit().await
let r = hub.files().generate_ids(...).doit().await
let r = hub.files().get(...).doit().await
let r = hub.files().insert(...).doit().await
let r = hub.files().list(...).doit().await
let r = hub.files().list_labels(...).doit().await
let r = hub.files().modify_labels(...).doit().await
let r = hub.files().patch(...).doit().await
let r = hub.files().touch(...).doit().await
let r = hub.files().trash(...).doit().await
let r = hub.files().untrash(...).doit().await
let r = hub.files().update(...).doit().await
let r = hub.files().watch(...).doit().await
resource()
和 activity(...)
调用创建 构建器。第二个处理 Activities
,支持配置即将进行的操作的各种方法(此处未显示)。它被设计成所有必需的参数都必须立即指定(即 (...)
),而所有可选的都可以按需 构建。doit()
方法执行与服务器实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-drive2 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_drive2 as drive2;
use drive2::api::File;
use drive2::{Result, Error};
use std::default::Default;
use drive2::{DriveHub, 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 = DriveHub::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 = File::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.files().patch(req, "fileId")
.use_content_as_indexable_text(true)
.update_viewed_date(false)
.timed_text_track_name("amet.")
.timed_text_language("takimata")
.supports_team_drives(true)
.supports_all_drives(true)
.set_modified_date(true)
.remove_parents("Lorem")
.pinned(false)
.ocr_language("dolor")
.ocr(true)
.new_revision(false)
.modified_date_behavior("amet")
.include_permissions_for_view("duo")
.include_labels("ipsum")
.enforce_single_parent(false)
.convert(true)
.add_parents("ipsum")
.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。
当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都有弹性。
上传和下载
如果某个方法支持下载,您应该读取作为 结果 部分的内容以获取媒体。如果该方法还支持一个 响应结果,它将默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载,您需要通过以下调用设置构建器: .param("alt", "media")
。
支持上传的方法可以使用多达 2 种不同的协议进行操作: 简单 和 可恢复。每种协议的独特性通过自定义的 doit(...)
方法来表示,分别命名为 upload(...)
和 upload_resumable(...)
。
定制和回调
您可以通过在最终 doit()
调用之前向 方法构建器 提供一个 代理 来修改 doit()
方法的调用方式。相应的函数将被调用以提供进度信息,并确定系统在失败时是否应重试。
代理特质 默认实现了,这允许您以最小的努力对其进行定制。
服务器请求中的可选部分
本库提供的所有结构都旨在通过 json 进行 编码 和 解码。选项用于表示部分请求和响应是有效的。大多数选项都是可以识别的 部分,它们可以通过名称进行识别,并将发送到服务器以指示请求中的设置部分或响应中所需的部份。
构建器参数
使用 方法构建器,您可以通过反复调用它的方法来准备一个操作调用。这些方法始终接受单个参数,以下语句适用于这些参数。
参数将始终复制或克隆到构建器中,以使它们与其原始的生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您需要在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将无效。
许可证
drive2 库由 Sebastian Thiel 创建,并置于 MIT 许可证下。您可以在仓库的 许可证文件 中阅读全文。
依赖项
~12-23MB
~344K SLoC