41 个版本 (24 个稳定版)

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

2794 in 网页编程


用于 google-urlshortener1-cli

MIT 许可证

130KB
2K SLoC

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

本文档由 urlshortener 包版本 5.0.5+20150519 生成,其中 20150519 是由 mako 代码生成器 v5.0.5 构建的 urlshortener:v1 架构的确切修订版。

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

功能

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

本库的结构

API 被结构化为以下主要项目

  • 枢纽
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体来说 ...

let r = hub.url().get(...).doit().await
let r = hub.url().insert(...).doit().await

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_urlshortener1 as urlshortener1;
use urlshortener1::{Result, Error};
use std::default::Default;
use urlshortener1::{Urlshortener, 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 = Urlshortener::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.url().get("shortUrl")
             .projection("magna")
             .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() 调用之前向 Method Builder 提供一个 代理 来更改 doit() 方法的方式。相应的方 法将被调用来提供进度信息,并确定系统在失败时应否重试。

代理特质 默认实现,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是为了能够通过 编码解码 来使用 json。使用可选(Optionals)来表示部分请求或响应是有效的。大多数可选值都被认为是 部分(Parts),这些部分可以通过名称识别,并将被发送到服务器以指示请求的设置部分或期望的响应部分。

构建器参数

使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终只接受一个参数,以下陈述是正确的。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~342K SLoC