Crate google_civicinfo2 [] [src]

This documentation was generated from Civic Info crate version 1.0.0+20160823, where 20160823 is the exact revision of the civicinfo:v2 schema built by the mako code generator v1.0.0.

Everything else about the Civic Info v2 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

  • Hub
    • a central object to maintain state and allow accessing all Activities
    • creates Method Builders which in turn allow access to individual Call Builders
  • Resources
    • primary types that you can apply Activities to
    • a collection of properties and Parts
    • Parts
      • a collection of properties
      • never directly used in Activities
  • Activities
    • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

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

Or specifically ...

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

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-civicinfo2 = "*"

A complete example

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(true)
             .election_id("et")
             .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),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be enocodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

AdministrationRegion

Describes information about a regional election administrative area.

AdministrativeBody

Information about an election administrative body (e.g. County Board of Elections).

Candidate

Information about a candidate running for elected office.

Channel

A social media or web channel for a candidate.

CivicInfo

Central instance to access all CivicInfo related resource activities

Contest

Information about a contest that appears on a voter's ballot.

DefaultDelegate

A delegate with a conservative default implementation, which is used if no other delegate is set.

DivisionMethods

A builder providing access to all methods supported on division resources. It is not used directly, but through the CivicInfo hub.

DivisionSearchCall

Searches for political divisions by their natural name or OCD ID.

DivisionSearchResponse

The result of a division search query.

DivisionSearchResult

Represents a political geographic division that matches the requested query.

Election

Information about the election that was queried.

ElectionElectionQueryCall

List of available elections to query.

ElectionMethods

A builder providing access to all methods supported on election resources. It is not used directly, but through the CivicInfo hub.

ElectionOfficial

Information about individual election officials.

ElectionVoterInfoQueryCall

Looks up information relevant to a voter based on the voter's registered address.

ElectionsQueryResponse

The list of elections available for this version of the API.

ElectoralDistrict

Describes the geographic scope of a contest.

ErrorResponse

A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound

GeographicDivision

Describes a political geography.

MethodInfo

Contains information about an API request.

MultiPartReader

Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.

Office

Information about an Office held by one or more Officials.

Official

Information about a person holding an elected office.

PollingLocation

A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.

RepresentativeInfoData

There is no detailed description.

RepresentativeInfoResponse

The result of a representative info lookup query.

RepresentativeMethods

A builder providing access to all methods supported on representative resources. It is not used directly, but through the CivicInfo hub.

RepresentativeRepresentativeInfoByAddresCall

Looks up political geography and representative information for a single address.

RepresentativeRepresentativeInfoByDivisionCall

Looks up representative information for a single geographic division.

SimpleAddressType

A simple representation of an address.

Source

Contains information about the data source for the element containing it.

VoterInfoResponse

The result of a voter info lookup query.

Enums

Error

Traits

CallBuilder

Identifies types which represent builders for a particular resource method

Delegate

A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.

Hub

Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.

MethodsBuilder

Identifies types for building methods of a particular resource type

NestedType

Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.

Part

Identifies types which are only used as part of other types, which usually are carrying the Resource trait.

ReadSeek

A utility to specify reader types which provide seeking capabilities too

RequestValue

Identifies types which are used in API requests.

Resource

Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.

ResponseResult

Identifies types which are used in API responses.

ToParts

A trait for all types that can convert themselves into a parts string

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.