48个版本 (30个稳定版)

5.0.5+20190616 2024年6月27日
5.0.4+20190616 2024年3月5日
5.0.3+20190616 2023年8月23日
5.0.2+20190616 2023年3月16日
0.1.2+20150305 2015年3月25日

#2370 in Web编程

Download history 3/week @ 2024-05-18 1/week @ 2024-05-25 4/week @ 2024-06-01 1/week @ 2024-06-08 90/week @ 2024-06-22 16/week @ 2024-06-29 4/week @ 2024-07-06

每月2,837次下载
用于 google-plusdomains1-cli

MIT 许可证

300KB
4K SLoC

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

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

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

特性

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

支持上传...

本库的结构

API结构如下主要项目

  • 中心
  • 资源
    • 您可以应用活动的基本类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 活动中 never 直接使用
  • 活动
    • 应用于资源的操作

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

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

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

或者具体来说...

let r = hub.comments().get(...).doit().await
let r = hub.comments().list(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_plusdomains1 as plusdomains1;
use plusdomains1::{Result, Error};
use std::default::Default;
use plusdomains1::{PlusDomains, 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 = PlusDomains::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.comments().list("activityId")
             .sort_order("magna")
             .page_token("no")
             .max_results(46)
             .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()方法之前修改其调用方式。相应的函数将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可

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

依赖关系

~12–24MB
~344K SLoC