31 个稳定版本 (5 个主要版本)

5.0.5+20240618 2024年6月27日
5.0.4+20240227 2024年3月5日
5.0.3+20230119 2023年8月24日
5.0.2+20230119 2023年3月16日
0.1.9+20150526 2015年10月19日

#2234 in Web编程

Download history 893/week @ 2024-04-27 1079/week @ 2024-05-04 830/week @ 2024-05-11 1104/week @ 2024-05-18 699/week @ 2024-05-25 542/week @ 2024-06-01 1396/week @ 2024-06-08 971/week @ 2024-06-15 1032/week @ 2024-06-22 607/week @ 2024-06-29 607/week @ 2024-07-06 547/week @ 2024-07-13 856/week @ 2024-07-20 682/week @ 2024-07-27 683/week @ 2024-08-03 864/week @ 2024-08-10

每月下载量 3,174
用于 google-pubsub1-cli

MIT 许可证

1MB
10K SLoC

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

本文档是根据 Pubsub crate 版本 5.0.5+20240618 生成的,其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 pubsub:v1 方案的精确修订版本。

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

功能

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

本库的结构

API 结构为以下主要项目

  • 中心
  • 资源
    • 可以应用 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 永远不会在 活动中 直接使用
  • 活动
    • 应用于 资源 的操作

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

通常,您可以通过以下方式调用 活动

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

或具体地 ...

let r = hub.projects().schemas_get_iam_policy(...).doit().await
let r = hub.projects().schemas_set_iam_policy(...).doit().await
let r = hub.projects().snapshots_get_iam_policy(...).doit().await
let r = hub.projects().snapshots_set_iam_policy(...).doit().await
let r = hub.projects().subscriptions_get_iam_policy(...).doit().await
let r = hub.projects().subscriptions_set_iam_policy(...).doit().await
let r = hub.projects().topics_get_iam_policy(...).doit().await
let r = hub.projects().topics_set_iam_policy(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pubsub1 as pubsub1;
use pubsub1::{Result, Error};
use std::default::Default;
use pubsub1::{Pubsub, 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 = Pubsub::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.projects().schemas_get_iam_policy("resource")
             .options_requested_policy_version(-33)
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用多达 2 种不同的协议进行:简单可恢复。每个的区别在于定制的 doit(...) 方法,分别命名为 upload(...)upload_resumable(...)

自定义和回调

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

代理特质 是默认实现的,这使得您可以用最少的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 特性

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

许可证

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

依赖关系

~12–23MB
~346K SLoC