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

本文档是从 Tasks 库版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 tasks:v1 方案的精确修订版。

有关 Tasks v1 API 的其他信息，请参阅 官方文档网站。

功能

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

• 任务列表
• 删除，获取，插入，列表，修补 和 更新
• 任务
• 清除，删除，获取，插入，列表，移动，修补 和 更新

本库的结构

API 被组织成以下主要项目

• 枢纽
  • 一个中央对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，它反过来允许访问单个 调用构建器
• 资源
  • 你可以应用 活动 的基本类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中从未直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或者具体来说...

let r = hub.tasks().clear(...).doit().await
let r = hub.tasks().delete(...).doit().await
let r = hub.tasks().get(...).doit().await
let r = hub.tasks().insert(...).doit().await
let r = hub.tasks().list(...).doit().await
let r = hub.tasks().move_(...).doit().await
let r = hub.tasks().patch(...).doit().await
let r = hub.tasks().update(...).doit().await

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

用法

设置你的项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_tasks1 as tasks1;
use tasks1::{Result, Error};
use std::default::Default;
use tasks1::{TasksHub, 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 = TasksHub::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.tasks().list("tasklist")
             .updated_min("magna")
             .show_hidden(true)
             .show_deleted(false)
             .show_completed(true)
             .page_token("amet.")
             .max_results(-20)
             .due_min("ipsum")
             .due_max("gubergren")
             .completed_min("Lorem")
             .completed_max("gubergren")
             .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")。

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

自定义和回调

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

默认实现了 委托特质，让您轻松自定义。

服务器请求的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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