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

google-driveactivity2

用于与Drive Activity(协议v2)交互的完整库

16个稳定版本 (4个主要版本)

5.0.5+20240623 2024年6月27日
5.0.4+20240302 2024年3月5日
5.0.3+20230122 2023年8月23日
5.0.2+20230122 2023年3月16日
1.0.10+20190702 2019年7月6日

#2477 in Web编程

Download history 5/week @ 2024-05-19 1/week @ 2024-06-02 1/week @ 2024-06-09 1/week @ 2024-06-16 84/week @ 2024-06-23 7/week @ 2024-06-30

1,006 每月下载量
用于 google-driveactivity2-cli

MIT 许可证

150KB
2K SLoC

google-driveactivity2 库允许访问Google Drive Activity(服务)的所有功能。

本文档是从Drive Activity crate版本5.0.5+20240623生成的,其中20240623mako代码生成器v5.0.5构建的driveactivity:v2模式的精确修订版本。

有关Drive Activity v2 API的其他信息,请参阅官方文档网站

功能

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

本库的结构

API结构如下主要项目

  • 枢纽
  • 资源
    • 可以将活动应用于的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 活动中 never 直接使用
  • 活动
    • 应用于资源的操作

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

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

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

或具体来说...

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

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

使用方法

设置你的项目

要使用此库,请将以下行放入你的 Cargo.toml 文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_driveactivity2 as driveactivity2;
use driveactivity2::api::QueryDriveActivityRequest;
use driveactivity2::{Result, Error};
use std::default::Default;
use driveactivity2::{DriveActivityHub, 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 = DriveActivityHub::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 = QueryDriveActivityRequest::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.activity().query(req)
             .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() 调用之前向 Method Builder 提供一个 代理 来改变 doit() 方法的调用方式。将调用相应的方法以提供进度信息,并确定系统在失败时是否应重试。

默认实现了 delegate trait,允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可

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

依赖项

~12–23MB
~346K SLoC