#transcoder #google #protocols #web #google-api #web-api

google-transcoder1

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

8 个版本 (稳定)

5.0.5+20240605 2024年6月27日
5.0.4+20240221 2024年3月5日
5.0.3+20230105 2023年8月24日
5.0.2+20230105 2023年3月17日
3.0.0+20220201 2022年3月8日

2493网页编程 中排名

Download history 40/week @ 2024-04-19 63/week @ 2024-04-26 25/week @ 2024-05-03 47/week @ 2024-05-10 85/week @ 2024-05-17 49/week @ 2024-05-24 36/week @ 2024-05-31 52/week @ 2024-06-07 7/week @ 2024-06-14 80/week @ 2024-06-21 37/week @ 2024-06-28 22/week @ 2024-07-05

664 每月下载量
用于 google-transcoder1-cli

MIT 许可证

270KB
3.5K SLoC

“google-transcoder1”库允许访问 Google Transcoder 服务(协议 v1)的所有功能。

本文档是从 Transcodercrate 版本 5.0.5+20240605 生成的,其中 20240605 是由 mako 代码生成器 v5.0.5 构建的 transcoder:v1 模式的确切修订版本。

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

特性

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

本库的结构

API 被组织成以下主要项

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

所有结构都被标记为适用的特性,以进一步分类它们并便于浏览。

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

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

或者具体...

let r = hub.projects().locations_jobs_create(...).doit().await
let r = hub.projects().locations_jobs_get(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_transcoder1 as transcoder1;
use transcoder1::api::Job;
use transcoder1::{Result, Error};
use std::default::Default;
use transcoder1::{Transcoder, 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 = Transcoder::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 = Job::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.projects().locations_jobs_create(req, "parent")
             .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")

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

定制和回调

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

代理特质具有默认实现,允许您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

参数将始终被复制或克隆到构建器中,以确保它们与它们的原始生命周期无关。

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC