该 google-tenor2 库允许访问 Google Tenor 服务的所有功能。

此文档是从 Tenor 包版本 5.0.5+20240805 生成的，其中 20240805 是由 mako 代码生成器 v5.0.5 构建的 tenor:v2 模式的确切版本。

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

功能

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

• 内容
• 块添加，块列表 和 块删除
• 帖子
• 列表

其他活动包括 ...

• anonid
• 自动完成
• 类别
• 特色
• 注册共享
• 渲染字幕
• 搜索
• 搜索建议
• 热门术语

此库的结构

API 结构如下主要项目

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

所有 结构 都带有适用的特征，以进一步分类它们并便于浏览。

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

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

或者更具体地 ...

let r = hub.methods().registershare(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_tenor2 as tenor2;
use tenor2::api::GoogleSearchTenorV2RegisterShareRequest;
use tenor2::{Result, Error};
use std::default::Default;
use tenor2::{Tenor, 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 = Tenor::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 = GoogleSearchTenorV2RegisterShareRequest::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.methods().registershare(req)
             .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(...)。

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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