#google-translate #google-api #translate #google #api #protocols

google-translate2

一个完整的库,用于与 Translate (协议 v2) 交互

43 个版本 (25 个稳定版)

5.0.5+20170525 2024 年 6 月 27 日
5.0.4+20170525 2024 年 3 月 5 日
5.0.3+20170525 2023 年 8 月 24 日
5.0.2+20170525 2023 年 3 月 16 日
0.1.2+20141123 2015 年 3 月 25 日

#2588 in Web 编程


用于 google-translate2-cli

MIT 许可证

165KB
2K SLoC

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

本文档是从 Translate crate 版本 5.0.5+20170525 生成的,其中 20170525 是由 mako 代码生成器 v5.0.5 构建的 translate:v2 架构的确切修订。

关于 Translate v2 API 的其他所有信息都可以在 官方文档网站 上找到。

功能

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

本库的结构

API 被组织成以下主要项目

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

所有 结构 都用适用的特征标记,以进一步分类它们并简化浏览。

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

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

或者具体来说...

let r = hub.detections().detect(...).doit().await
let r = hub.detections().list(...).doit().await

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

用法

设置项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_translate2 as translate2;
use translate2::api::DetectLanguageRequest;
use translate2::{Result, Error};
use std::default::Default;
use translate2::{Translate, 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 = Translate::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 = DetectLanguageRequest::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.detections().detect(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 DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用最多两种不同的协议:简单可恢复。每个的独特性由定制的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

定制和回调

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

该库中的委托特质默认实现,允许您以最小努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–22MB
~341K SLoC