google-civicinfo2 库允许访问Google Civic Info服务的所有功能。

此文档是从版本 1.0.0+20160823 的 Civic Info 包生成的，其中 20160823 是由 mako 代码生成器 v1.0.0 构建的 civicinfo:v2 模式的确切修订版。

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

特性

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

• division
• search
• elections
• 选举查询 和 选民信息查询
• representatives
• 按地址的代表性信息 和 按划分的代表性信息

本库结构

API结构如下主要项

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

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

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

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

或者具体...

let r = hub.elections().voter_info_query(...).doit()
let r = hub.elections().election_query(...).doit()

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

使用方法

设置你的项目

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

[dependencies]
google-civicinfo2 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_civicinfo2 as civicinfo2;
use civicinfo2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use civicinfo2::CivicInfo;

// 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 = CivicInfo::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.elections().voter_info_query("address")
             .return_all_available_data(true)
             .official_only(false)
             .election_id("sed")
             .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(...)。

定制和回调

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

默认实现了 delegate trait，这使得您可以以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都旨在通过json进行编码和解码。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都被视为部分，通过名称可识别，这些部分将被发送到服务器，以指示请求的集合部分或响应中所需的部分。

构建器参数

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

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

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

许可证

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