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

google-drive3-fork

Sebastian Thiel 完整库的分支,用于与 drive (协议 v3) 交互

3 个稳定版本

使用旧的 Rust 2015

1.0.10 2018年6月14日

#11#google-drive

Download history 8/week @ 2024-02-22 2/week @ 2024-02-29 40/week @ 2024-03-28 31/week @ 2024-04-04

152 每月下载次数

MIT 许可证

675KB
9K SLoC

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

本文档由 drive 包版本 1.0.7+20171201 生成,其中 20171201 是由 mako 代码生成器 v1.0.7 构建的 drive:v3 架构的确切修订版本。

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

特性

从中心 中心 简单地处理以下 资源 ...

支持由 ... 上传

支持由 ... 下载

支持订阅由 ...

此库的结构

API结构为以下主要项目

  • 中心
  • 资源
    • 主要类型,您可以将活动应用于这些类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 从未在活动中直接使用
  • 活动
    • 应用于资源的操作

所有结构都带有适用的特性,以进一步分类它们并简化浏览。

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

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

或具体来说 ...

let r = hub.files().watch(...).doit()
let r = hub.files().empty_trash(...).doit()
let r = hub.files().generate_ids(...).doit()
let r = hub.files().copy(...).doit()
let r = hub.files().create(...).doit()
let r = hub.files().list(...).doit()
let r = hub.files().delete(...).doit()
let r = hub.files().update(...).doit()
let r = hub.files().get(...).doit()
let r = hub.files().export(...).doit()

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

用法

设置你的项目

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

[dependencies]
google-drive3 = "*"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_drive3 as drive3;
use drive3::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use drive3::Drive;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Drive::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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("eirmod")
             .supports_team_drives(true)
             .spaces("Stet")
             .q("sed")
             .page_token("et")
             .page_size(-18)
             .order_by("kasd")
             .include_team_drive_items(true)
             .corpus("takimata")
             .corpora("justo")
             .doit();

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::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方法表示,分别命名为uploadupload_resumable

自定义和回调

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

委托特质默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是设计为可以通过 编码解码 来使用 json 格式。可选参数用于表示部分请求和响应是有效的。大多数可选参数被认为是 部分,可以通过名称识别,这些部分将发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

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

  • POD 以副本形式传递
  • 字符串作为 &str 传递
  • 请求值 被移动

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

许可证

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

依赖项

~8–18MB
~297K SLoC