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

本文档由版本 5.0.5+20240613 的 Docs Crate生成，其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 docs:v1 模式的确切版本。

关于Docs v1 API的所有其他信息都可以在 官方文档网站 找到。

功能

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

• 文档
• 批量更新，创建 和 获取

库的结构

API被组织成以下主要项目

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器又允许访问单个 调用构建器
• 资源
  • 主要类型，可以应用于 活动
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 从未在 活动中 直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或者具体地 ...

let r = hub.documents().batch_update(...).doit().await
let r = hub.documents().create(...).doit().await
let r = hub.documents().get(...).doit().await

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

用法

设置你的项目

要使用此库，你需要在你的Cargo.toml文件中放入以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_docs1 as docs1;
use docs1::api::BatchUpdateDocumentRequest;
use docs1::{Result, Error};
use std::default::Default;
use docs1::{Docs, 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 = Docs::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 = BatchUpdateDocumentRequest::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.documents().batch_update(req, "documentId")
             .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。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

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

支持上传的方法可以使用多达2种不同的协议进行上传：简单和可恢复。每种方法的独特性由自定义的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

定制和回调

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

代理特质默认实现，允许您以最少的努力进行定制。

服务器请求的可选部分

本库提供的所有结构都旨在通过 编码 和 解码 通过 json。使用可选类型来表示部分请求和响应都是有效的。大多数可选类型都被视为 Parts，这些部分可以通过名称识别，并将发送到服务器以指示请求的集合部分或响应中期望的部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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