google-books1 库允许访问 Google 书籍服务的所有功能。

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

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

功能

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

• 书架
• 获取、列出 和 卷列表
• 云上传
• 添加书籍、删除书籍 和 更新书籍
• 字典
• 列出离线元数据
• 家庭共享
• 获取家庭信息、共享 和 取消共享
• 层
• 获取注释数据、列出注释数据、获取、列出、获取卷注释 和 列出卷注释
• 我的配置
• 获取用户设置，发布下载权限，请求访问，同步卷许可证和更新用户设置
• 我的图书馆
• 删除标注，插入标注，标注列表，标注摘要，更新标注，添加到书架，清除书架内容，获取书架，书架列表，移动书架中的卷，从书架移除卷，书架卷列表，获取阅读位置和设置阅读位置
• 通知
• 获取
• 入职
• 列出类别和列出类别卷
• 个性化流
• 获取
• 促销优惠
• 接受，忽略和获取
• 系列
• 获取和会员获取
• 卷
• 关联列表，获取，列表，我的书列表，推荐列表，推荐评分和用户上传列表

本库的结构

API结构为以下主要项目

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

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

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

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

或者具体来说 ...

let r = hub.cloudloading().delete_book(...).doit().await
let r = hub.familysharing().share(...).doit().await
let r = hub.familysharing().unshare(...).doit().await
let r = hub.mylibrary().annotations_delete(...).doit().await
let r = hub.mylibrary().bookshelves_add_volume(...).doit().await
let r = hub.mylibrary().bookshelves_clear_volumes(...).doit().await
let r = hub.mylibrary().bookshelves_move_volume(...).doit().await
let r = hub.mylibrary().bookshelves_remove_volume(...).doit().await
let r = hub.mylibrary().readingpositions_set_position(...).doit().await
let r = hub.promooffer().accept(...).doit().await
let r = hub.promooffer().dismiss(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_books1 as books1;
use books1::{Result, Error};
use std::default::Default;
use books1::{Books, 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 = Books::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.promooffer().accept()
             .volume_id("et")
             .serial("magna")
             .product("no")
             .offer_id("ipsum")
             .model("voluptua.")
             .manufacturer("At")
             .device("sanctus")
             .android_id("sed")
             .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() 方法的调用方式。相应的方法将被调用以提供进度信息，并确定系统是否应在失败时重试。

代理 trait 默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述是真实的。

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

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

Cargo 功能

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

许可

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