42 个稳定版本 (5 个主要版本)

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年2月22日
0.1.11+20160126 2016年1月30日

#45 in 网络编程

Download history 4685/week @ 2024-05-02 4672/week @ 2024-05-09 4938/week @ 2024-05-16 5243/week @ 2024-05-23 4567/week @ 2024-05-30 4241/week @ 2024-06-06 4728/week @ 2024-06-13 4262/week @ 2024-06-20 5402/week @ 2024-06-27 4493/week @ 2024-07-04 5007/week @ 2024-07-11 6146/week @ 2024-07-18 6097/week @ 2024-07-25 4840/week @ 2024-08-01 5288/week @ 2024-08-08 5119/week @ 2024-08-15

22,933 每月下载量
用于 7 crate

MIT 许可证

1MB
12K SLoC

google-drive3 库允许访问 Google drive 服务的所有功能。

本文档由 drive crate 版本 5.0.5+20240618 生成,其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 drive:v3 模式的确切修订版。

有关 drive v3 API 的其他所有信息,请参阅 官方文档网站

特性

从中心 枢纽 轻松处理以下 资源...

支持由 ... 上传

支持由 ... 下载

支持由 ... 订阅

本库的结构

API 被组织为以下主要项

  • 中心
  • 资源
    • 主要类型,您可以将其应用于 活动
    • 属性和 部分 的集合
    • 部分
      • 属性集合
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

所有结构都被标记了相应的特征,以进一步分类并简化浏览。

一般来说,你可以这样调用活动

let r = hub.resource().activity(...).doit().await

或者具体来说...

let r = hub.files().copy(...).doit().await
let r = hub.files().create(...).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().list(...).doit().await
let r = hub.files().list_labels(...).doit().await
let r = hub.files().modify_labels(...).doit().await
let r = hub.files().update(...).doit().await
let r = hub.files().watch(...).doit().await

resource()activity(...)调用创建了构建器。第二个与Activities相关,支持配置即将进行的操作的各种方法(此处未展示)。它被设计成必须立即指定所有必需的参数(即(...)),而所有可选的参数都可以根据需要构建doit()方法执行与服务器实际的通信并返回相应的结果。

使用方法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下行

[dependencies]
google-drive3 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_drive3 as drive3;
use drive3::{Result, Error};
use std::default::Default;
use drive3::{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);
// 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().list()
             .team_drive_id("et")
             .supports_team_drives(true)
             .supports_all_drives(false)
             .spaces("amet.")
             .q("takimata")
             .page_token("amet.")
             .page_size(-20)
             .order_by("ipsum")
             .include_team_drive_items(true)
             .include_permissions_for_view("Lorem")
             .include_labels("gubergren")
             .include_items_from_all_drives(false)
             .drive_id("dolor")
             .corpus("ea")
             .corpora("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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统对各种错误具有潜在的抗性。

上传和下载

如果一个方法支持下载,你应该读取响应体,这是Result的一部分,以获取媒体。如果此方法还支持Response Result,它将默认返回它。你可以将其视为实际媒体元数据。要触发媒体下载,你必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种协议的独特性通过自定义的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

定制和回调

您可以通过向 方法构建器 提供一个 代理 来修改 doit() 方法的调用方式。在最终调用 doit() 之前。相应的会调用方法来提供进度信息,并确定系统在失败时是否应该重试。

代理特质 默认实现,让您可以轻松自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码解码。可选参数用于表示部分请求或响应是有效的。大多数可选参数都是可识别的 部分,它们将发送到服务器以指示请求中设置的各个部分或响应中所需的各个部分。

构建器参数

通过使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下语句对参数有效。

  • POD 通过复制传递
  • 字符串作为 &str 传递
  • 请求值 被移动

参数将始终被复制或克隆到构建器中,以使它们与其原始生命周期独立。

Cargo 功能

  • utoipa - 添加对 utoipa 的支持,并在所有类型上派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需的类型,否则生成的 openapi 规范将无效。

许可证

drive3 库由 Sebastian Thiel 生成,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。

依赖项

~12–23MB
~342K SLoC