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

本文档是从 Keep crate 版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 keep:v1 架构的确切修订版本。

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

功能

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

• 媒体
• 下载
• 笔记
• 创建、删除、获取、列表、权限批量创建 和 权限批量删除

支持以下 ... 下载

• 下载媒体

本库的结构

API 结构如下

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

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

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

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

或者具体来说...

let r = hub.notes().permissions_batch_create(...).doit().await
let r = hub.notes().permissions_batch_delete(...).doit().await
let r = hub.notes().create(...).doit().await
let r = hub.notes().delete(...).doit().await
let r = hub.notes().get(...).doit().await
let r = hub.notes().list(...).doit().await

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

使用方法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_keep1 as keep1;
use keep1::{Result, Error};
use std::default::Default;
use keep1::{Keep, 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 = Keep::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.notes().list()
             .page_token("et")
             .page_size(-33)
             .filter("no")
             .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 提供一个 delegate 来改变 doit() 方法的调用方式。相应的方将调用以提供进度信息，并确定系统在失败时是否应重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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