google-calendar3 库允许访问 Google 日历服务的所有功能。

本文档是从版本 5.0.5+20240328 的 calendar crate 生成的，其中 20240328 是由 mako 代码生成器 v5.0.5 构建的 calendar:v3 模式的确切修订。

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

功能

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

• acl
• 删除, 获取, 插入, 列表, 修补, 更新 和 监视
• 日历列表
• 删除, 获取, 插入, 列表, 修补, 更新 和 监视
• 日历
• 清除，删除，获取，插入，修补和更新
• 通道
• 停止
• 颜色
• 获取
• 事件
• 删除，获取，导入，插入，实例，列表，移动，修补，快速添加，更新以及监视
• 空闲时间
• 查询
• 设置
• 获取，列表以及监视

由...支持的订阅

• 列表ACL
• 监视ACL
• 列表日历列表
• 监视日历列表
• 实例事件
• 列表事件
• 监视事件
• 列表设置
• 监视设置

库结构

API结构如下主要项

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

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

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

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

或者具体...

let r = hub.events().delete(...).doit().await
let r = hub.events().get(...).doit().await
let r = hub.events().import(...).doit().await
let r = hub.events().insert(...).doit().await
let r = hub.events().instances(...).doit().await
let r = hub.events().list(...).doit().await
let r = hub.events().move_(...).doit().await
let r = hub.events().patch(...).doit().await
let r = hub.events().quick_add(...).doit().await
let r = hub.events().update(...).doit().await
let r = hub.events().watch(...).doit().await

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

用法

设置您的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_calendar3 as calendar3;
use calendar3::api::Channel;
use calendar3::{Result, Error};
use std::default::Default;
use calendar3::{CalendarHub, 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 = CalendarHub::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 = Channel::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.events().watch(req, "calendarId")
             .updated_min(chrono::Utc::now())
             .time_zone("magna")
             .time_min(chrono::Utc::now())
             .time_max(chrono::Utc::now())
             .sync_token("no")
             .single_events(true)
             .show_hidden_invitations(false)
             .show_deleted(true)
             .add_shared_extended_property("amet.")
             .q("duo")
             .add_private_extended_property("ipsum")
             .page_token("gubergren")
             .order_by("Lorem")
             .max_results(-12)
             .max_attendees(-75)
             .i_cal_uid("dolor")
             .add_event_types("ea")
             .always_include_email(true)
             .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 枚举的返回值提供，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

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

上传和下载

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

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

自定义和回调

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

delegate trait 具有默认实现，允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码 和 解码。可选部分用于指示部分请求或响应是有效的。大多数可选部分都是可识别的 Parts，它们通过名称标识，将被发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

使用 方法构建器，您可以通过反复调用它的方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述对它们是正确的。

• PODs 通过复制传递
• 字符串以 &str 的形式传递
• 请求值被移动

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

许可协议

calendar3 库由 Sebastian Thiel 制作，并置于 MIT 许可协议下。您可以在存储库的 许可文件 中阅读全文。