46 个版本 (30 个稳定版)

5.0.5+20190616 2024年6月27日
5.0.4+20190616 2024年3月5日
5.0.3+20190616 2023年8月24日
5.0.2+20190616 2023年3月16日
0.1.8+20150303 2015年6月19日

2551网页编程

Download history 4/week @ 2024-05-19 3/week @ 2024-06-02 1/week @ 2024-06-09 1/week @ 2024-06-16 98/week @ 2024-06-23 14/week @ 2024-06-30

2,720 每月下载量
用于 google-plus1-cli

MIT 许可证

260KB
3.5K SLoC

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

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

有关 plus v1 API 的其他所有信息,请参阅 官方文档网站

特性

从中心 枢纽 简单地处理以下 资源...

本库结构

API 结构如下

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

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

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

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

或者具体来说...

let r = hub.people().list(...).doit().await
let r = hub.people().list_by_activity(...).doit().await
let r = hub.people().search(...).doit().await

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

用法

设置你的项目

要使用此库,你需要在你的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_plus1 as plus1;
use plus1::{Result, Error};
use std::default::Default;
use plus1::{Plus, 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 = Plus::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.people().list("userId", "collection")
             .page_token("no")
             .order_by("ipsum")
             .max_results(73)
             .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(...)

定制和回调

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

默认实现了 代理特质,让您能够以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~346K SLoC