该 google-libraryagent1 库允许访问 Google Libraryagent 服务（协议 v1）的所有功能。

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

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

功能

轻松从中央 枢纽 ...

• 书架
• 图书借阅，获取图书，列出图书，归还图书，获取 和 列出

本库的结构

API 结构如下主要项目

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

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

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

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

或者更具体...

let r = hub.shelves().books_borrow(...).doit().await
let r = hub.shelves().books_get(...).doit().await
let r = hub.shelves().books_return(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_libraryagent1 as libraryagent1;
use libraryagent1::{Result, Error};
use std::default::Default;
use libraryagent1::{Libraryagent, 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 = Libraryagent::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.shelves().books_borrow("name")
             .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")。

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

自定义和回调

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

委托特质具有默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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