Crate google_mirror1

This documentation was generated from mirror crate version 1.0.6+20170419, where 20170419 is the exact revision of the mirror:v1 schema built by the mako code generator v1.0.6.

Everything else about the mirror v1 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 ...

• accounts
  • insert
• contacts
  • delete, get, insert, list, patch and update
• locations
  • get and list
• settings
  • get
• subscriptions
  • delete, insert, list and update
• timeline
  • attachments delete, attachments get, attachments insert, attachments list, delete, get, insert, list, patch and update

Upload supported by ...

• update timeline
• insert timeline
• attachments insert timeline

Download supported by ...

• attachments get timeline

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.contacts().insert(...).doit()
let r = hub.contacts().delete(...).doit()
let r = hub.contacts().list(...).doit()
let r = hub.contacts().update(...).doit()
let r = hub.contacts().patch(...).doit()
let r = hub.contacts().get(...).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-mirror1 = "*"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_mirror1 as mirror1;
use mirror1::Contact;
use mirror1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use mirror1::Mirror;
 
// 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::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Mirror::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Contact::default();
 
// 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.contacts().update(req, "id")
             .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.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

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

Structs

Account	Represents an account passed into the Account Manager on Glass.
AccountInsertCall	Inserts a new account for a user
AccountMethods	A builder providing access to all methods supported on account resources. It is not used directly, but through the Mirror hub.
Attachment	Represents media content, such as a photo, that can be attached to a timeline item.
AttachmentsListResponse	A list of Attachments. This is the response from the server to GET requests on the attachments collection.
AuthToken	There is no detailed description.
Command	A single menu command that is part of a Contact.
Contact	A person or group that can be used as a creator or a contact.
ContactDeleteCall	Deletes a contact.
ContactGetCall	Gets a single contact by ID.
ContactInsertCall	Inserts a new contact.
ContactListCall	Retrieves a list of contacts for the authenticated user.
ContactMethods	A builder providing access to all methods supported on contact resources. It is not used directly, but through the Mirror hub.
ContactPatchCall	Updates a contact in place. This method supports patch semantics.
ContactUpdateCall	Updates a contact in place.
ContactsListResponse	A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection.
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
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
Location	A geographic location that can be associated with a timeline item.
LocationGetCall	Gets a single location by ID.
LocationListCall	Retrieves a list of locations for the user.
LocationMethods	A builder providing access to all methods supported on location resources. It is not used directly, but through the Mirror hub.
LocationsListResponse	A list of Locations. This is the response from the server to GET requests on the locations collection.
MenuItem	A custom menu item that can be presented to the user by a timeline item.
MenuValue	A single value that is part of a MenuItem.
MethodInfo	Contains information about an API request.
Mirror	Central instance to access all Mirror related resource activities
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.
Notification	A notification delivered by the API.
NotificationConfig	Controls how notifications for a timeline item are presented to the user.
Setting	A setting for Glass.
SettingGetCall	Gets a single setting by ID.
SettingMethods	A builder providing access to all methods supported on setting resources. It is not used directly, but through the Mirror hub.
Subscription	A subscription to events on a collection.
SubscriptionDeleteCall	Deletes a subscription.
SubscriptionInsertCall	Creates a new subscription.
SubscriptionListCall	Retrieves a list of subscriptions for the authenticated user and service.
SubscriptionMethods	A builder providing access to all methods supported on subscription resources. It is not used directly, but through the Mirror hub.
SubscriptionUpdateCall	Updates an existing subscription in place.
SubscriptionsListResponse	A list of Subscriptions. This is the response from the server to GET requests on the subscription collection.
TimelineAttachmentDeleteCall	Deletes an attachment from a timeline item.
TimelineAttachmentGetCall	Retrieves an attachment on a timeline item by item ID and attachment ID.
TimelineAttachmentInsertCall	Adds a new attachment to a timeline item.
TimelineAttachmentListCall	Returns a list of attachments for a timeline item.
TimelineDeleteCall	Deletes a timeline item.
TimelineGetCall	Gets a single timeline item by ID.
TimelineInsertCall	Inserts a new item into the timeline.
TimelineItem	Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
TimelineListCall	Retrieves a list of timeline items for the authenticated user.
TimelineListResponse	A list of timeline items. This is the response from the server to GET requests on the timeline collection.
TimelineMethods	A builder providing access to all methods supported on timeline resources. It is not used directly, but through the Mirror hub.
TimelinePatchCall	Updates a timeline item in place. This method supports patch semantics.
TimelineUpdateCall	Updates a timeline item in place.
UserAction	Represents an action taken by the user that triggered a notification.
UserData	There is no detailed description.

Enums

Error
Scope	Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

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.