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

本文档是从 oauth2 crate 版本 0.1.14+20160330 生成的，其中 20160330 是由 mako 代码生成器 v0.1.14 构建的 oauth2:v2 架构的确切修订版本。

有关 oauth2 v2 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 用户信息
• 获取 和 v2 me get

其他活动...

• 获取 open id connect 证书
• 令牌信息

本库的结构

API 被组织成以下主要项目

• 中心
  • 一个中心对象，用于维护状态和允许访问所有 活动
  • 创建 方法构建器，后者反过来允许访问单个 调用构建器
• 资源
  • 主要类型，可以将 活动 应用到这些类型上
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或者具体地...

let r = hub.userinfo().v2_me_get(...).doit()
let r = hub.userinfo().get(...).doit()

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

用法

设置您的项目

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

[dependencies]
google-oauth2_v2 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_oauth2_v2 as oauth2_v2;
use oauth2_v2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use oauth2_v2::Oauth2;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Oauth2::new(hyper::Client::new(), 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.userinfo().v2_me_get()
             .doit();

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::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")。

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

定制和回调

您可以通过提供代理给方法构建器，在最终调用doit()之前，改变doit()方法的调用方式。将调用相应的方法以提供进度信息，并确定系统在失败时是否应该重试。

委托特性（delegate trait）默认实现，让您可以以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

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