#google-drive #drive #web-api #google #protocols #api #web

anni-google-drive3

支持范围功能的与 drive (协议 v3) 交互的修复库

1 个不稳定版本

0.1.0+4.0.0-20220225 2022 年 12 月 5 日

#12#google-drive


用于 2 crates

MIT 许可证

1MB
12K SLoC

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

此文档是从 drive crate 版本 3.0.0+20220225 生成的,其中 20220225 是由 mako 代码生成器 v3.0.0 构建的 drive:v3 方案的精确修订。

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

补丁详情

我们对原始 crate 进行了修复,以添加对 Range 头的支持,该头用于 get 操作。

功能

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

由...支持的上传

由...支持的下载数据

由...支持的订阅

此库的结构

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().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};

// 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::HttpsConnector::with_native_roots()), 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_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(...)

自定义和回调

您可以通过向Method Builder提供代理来修改调用doit()方法的方式,在执行最终的doit()调用之前。相应的函数将被调用以提供进度信息,并确定系统是否在失败时应该重试。

代理特例默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码解码。使用可选部分来表示部分请求或响应是有效的。大多数可选部分都是被认为部分,可以通过名称识别,这些部分将被发送到服务器以指示请求中设置的部件或响应中所需的部件。

构建器参数

使用方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终只接受一个参数,以下陈述适用于该参数。

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

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

许可证

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

依赖项

~17–29MB
~544K SLoC