8个版本 (稳定)

5.0.5+20220305 2024年6月27日
5.0.4+20220305 2024年3月5日
5.0.3+20220305 2023年8月23日
5.0.2+20220305 2023年3月16日
3.0.0+20220305 2022年3月8日

#2615 in Web编程

Download history 5/week @ 2024-05-19 85/week @ 2024-06-23 29/week @ 2024-06-30

每月474次 下载
用于 google-ideahub1_beta-cli

MIT 许可证

155KB
2K SLoC

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

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

关于Ideahub v1_beta API的其他所有信息,可以在官方文档站点找到。

功能

轻松从中央 hub ...

本库结构

API结构如下

  • Hub
  • 资源
    • 可以应用 Activities 的主要类型
    • 属性和 Parts 的集合
    • Parts
      • 属性的集合
      • 永远不会直接用于 Activities
  • Activities
    • 应用于 Resources 的操作

所有 structures 都带有适用的 traits,以进一步分类它们并便于浏览。

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

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

或者具体地 ...

let r = hub.platforms().properties_idea_activities_create(...).doit().await

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

使用方法

设置项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_ideahub1_beta as ideahub1_beta;
use ideahub1_beta::api::GoogleSearchIdeahubV1betaIdeaActivity;
use ideahub1_beta::{Result, Error};
use std::default::Default;
use ideahub1_beta::{Ideahub, 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 = Ideahub::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 = GoogleSearchIdeahubV1betaIdeaActivity::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.platforms().properties_idea_activities_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 Delegate,或者Authenticator Delegate

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

上传和下载

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

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

定制和回调

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

delegate trait具有默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

本库中提供的所有结构都是设计为可以通过 编码解码 来进行 json 格式的转换。使用可选值来表示部分请求或响应是有效的。大多数可选值都是 Parts,这些可以通过名称识别,将它们发送到服务器以指示请求或响应中所需的组件。

构建器参数

通过使用 方法构建器,您可以通过多次调用其方法来准备一个操作调用。这些方法总是接受单个参数,以下陈述对此适用。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC