Crate google_mirror1[][src]

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

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


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

Upload supported by ...

Download supported by ...

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 ...

This example is not tested
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.


Setting up your Project

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

google-mirror1 = "*"
# This project intentionally uses an old version of Hyper. See
# for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

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,
                              <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")
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::UploadSizeLimitExceeded(_, _)
        |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.



Represents an account passed into the Account Manager on Glass.


Inserts a new account for a user


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


Represents media content, such as a photo, that can be attached to a timeline item.


A list of Attachments. This is the response from the server to GET requests on the attachments collection.


There is no detailed description.


A single menu command that is part of a Contact.


A person or group that can be used as a creator or a contact.


Deletes a contact.


Gets a single contact by ID.


Inserts a new contact.


Retrieves a list of contacts for the authenticated user.


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


Updates a contact in place. This method supports patch semantics.


Updates a contact in place.


A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection.


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


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


A geographic location that can be associated with a timeline item.


Gets a single location by ID.


Retrieves a list of locations for the user.


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


A list of Locations. This is the response from the server to GET requests on the locations collection.


A custom menu item that can be presented to the user by a timeline item.


A single value that is part of a MenuItem.


Contains information about an API request.


Central instance to access all Mirror related resource activities


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.


A notification delivered by the API.


Controls how notifications for a timeline item are presented to the user.


A setting for Glass.


Gets a single setting by ID.


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


A subscription to events on a collection.


Deletes a subscription.


Creates a new subscription.


Retrieves a list of subscriptions for the authenticated user and service.


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


Updates an existing subscription in place.


A list of Subscriptions. This is the response from the server to GET requests on the subscription collection.


Deletes an attachment from a timeline item.


Retrieves an attachment on a timeline item by item ID and attachment ID.


Adds a new attachment to a timeline item.


Returns a list of attachments for a timeline item.


Deletes a timeline item.


Gets a single timeline item by ID.


Inserts a new item into the timeline.


Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.


Retrieves a list of timeline items for the authenticated user.


A list of timeline items. This is the response from the server to GET requests on the timeline collection.


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


Updates a timeline item in place. This method supports patch semantics.


Updates a timeline item in place.


Represents an action taken by the user that triggered a notification.


There is no detailed description.



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



Identifies types which represent builders for a particular resource method


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


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.


Identifies types for building methods of a particular resource type


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


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


A utility to specify reader types which provide seeking capabilities too


Identifies types which are used in API requests.


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


Identifies types which are used in API responses.


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



Type Definitions


A universal result type used as return for all calls.