// DO NOT EDIT ! // This file was generated automatically from 'src/mako/api/lib.rs.mako' // DO NOT EDIT ! //! This documentation was generated from *blogger* crate version *0.1.15+20150422*, where *20150422* is the exact revision of the *blogger:v3* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.15*. //! //! Everything else about the *blogger* *v3* API can be found at the //! [official documentation site](https://developers.google.com/blogger/docs/3.0/getting_started). //! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/blogger3). //! # Features //! //! Handle the following *Resources* with ease from the central [hub](struct.Blogger.html) ... //! //! * [blog user infos](struct.BlogUserInfo.html) //! * [*get*](struct.BlogUserInfoGetCall.html) //! * [blogs](struct.Blog.html) //! * [*get*](struct.BlogGetCall.html), [*get by url*](struct.BlogGetByUrlCall.html) and [*list by user*](struct.BlogListByUserCall.html) //! * [comments](struct.Comment.html) //! * [*approve*](struct.CommentApproveCall.html), [*delete*](struct.CommentDeleteCall.html), [*get*](struct.CommentGetCall.html), [*list*](struct.CommentListCall.html), [*list by blog*](struct.CommentListByBlogCall.html), [*mark as spam*](struct.CommentMarkAsSpamCall.html) and [*remove content*](struct.CommentRemoveContentCall.html) //! * page views //! * [*get*](struct.PageViewGetCall.html) //! * [pages](struct.Page.html) //! * [*delete*](struct.PageDeleteCall.html), [*get*](struct.PageGetCall.html), [*insert*](struct.PageInsertCall.html), [*list*](struct.PageListCall.html), [*patch*](struct.PagePatchCall.html), [*publish*](struct.PagePublishCall.html), [*revert*](struct.PageRevertCall.html) and [*update*](struct.PageUpdateCall.html) //! * [post user infos](struct.PostUserInfo.html) //! * [*get*](struct.PostUserInfoGetCall.html) and [*list*](struct.PostUserInfoListCall.html) //! * [posts](struct.Post.html) //! * [*delete*](struct.PostDeleteCall.html), [*get*](struct.PostGetCall.html), [*get by path*](struct.PostGetByPathCall.html), [*insert*](struct.PostInsertCall.html), [*list*](struct.PostListCall.html), [*patch*](struct.PostPatchCall.html), [*publish*](struct.PostPublishCall.html), [*revert*](struct.PostRevertCall.html), [*search*](struct.PostSearchCall.html) and [*update*](struct.PostUpdateCall.html) //! * [users](struct.User.html) //! * [*get*](struct.UserGetCall.html) //! //! //! //! //! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](../index.html). //! //! # Structure of this Library //! //! The API is structured into the following primary items: //! //! * **[Hub](struct.Blogger.html)** //! * a central object to maintain state and allow accessing all *Activities* //! * creates [*Method Builders*](trait.MethodsBuilder.html) which in turn //! allow access to individual [*Call Builders*](trait.CallBuilder.html) //! * **[Resources](trait.Resource.html)** //! * primary types that you can apply *Activities* to //! * a collection of properties and *Parts* //! * **[Parts](trait.Part.html)** //! * a collection of properties //! * never directly used in *Activities* //! * **[Activities](trait.CallBuilder.html)** //! * 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: //! //! ```Rust,ignore //! let r = hub.resource().activity(...).doit() //! ``` //! //! Or specifically ... //! //! ```ignore //! let r = hub.posts().insert(...).doit() //! let r = hub.posts().publish(...).doit() //! let r = hub.posts().delete(...).doit() //! let r = hub.posts().revert(...).doit() //! let r = hub.posts().update(...).doit() //! let r = hub.posts().get_by_path(...).doit() //! let r = hub.posts().search(...).doit() //! let r = hub.posts().patch(...).doit() //! let r = hub.posts().list(...).doit() //! let r = hub.posts().get(...).doit() //! ``` //! //! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. 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][builder-pattern] 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: //! //! ```toml //! [dependencies] //! google-blogger3 = "*" //! ``` //! //! ## A complete example //! //! ```test_harness,no_run //! extern crate hyper; //! extern crate yup_oauth2 as oauth2; //! extern crate google_blogger3 as blogger3; //! use blogger3::{Result, Error}; //! # #[test] fn egal() { //! use std::default::Default; //! use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; //! use blogger3::Blogger; //! //! // 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(), //! ::default(), None); //! let mut hub = Blogger::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.posts().list("blogId") //! .view("diam") //! .add_status("ut") //! .start_date("ut") //! .page_token("amet.") //! .order_by("ipsum") //! .max_results(14) //! .labels("dolor") //! .fetch_images(true) //! .fetch_bodies(true) //! .end_date("eirmod") //! .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](enum.Result.html) enumeration as return value of //! the doit() methods, or handed as possibly intermediate results to either the //! [Hub Delegate](trait.Delegate.html), or the [Authenticator Delegate](../yup-oauth2/trait.AuthenticatorDelegate.html). //! //! 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](enum.Result.html), should be //! read by you to obtain the media. //! If such a method also supports a [Response Result](trait.ResponseResult.html), 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](trait.Delegate.html) to the //! [Method Builder](trait.CallBuilder.html) 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](trait.Delegate.html) 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](trait.RequestValue.html) and //! [decodable](trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses //! are valid. //! Most optionals are are considered [Parts](trait.Part.html) 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](trait.CallBuilder.html), 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][wiki-pod] are handed by copy //! * strings are passed as `&str` //! * [request values](trait.RequestValue.html) are moved //! //! Arguments will always be copied or cloned into the builder, to make them independent of their original life times. //! //! [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure //! [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern //! [google-go-api]: https://github.com/google/google-api-go-client //! //! // Unused attributes happen thanks to defined, but unused structures // We don't warn about this, as depending on the API, some data structures or facilities are never used. // Instead of pre-determining this, we just disable the lint. It's manually tuned to not have any // unused imports in fully featured APIs. Same with unused_mut ... . #![cfg_attr(feature = "nightly", feature(custom_derive, custom_attribute, plugin))] #![cfg_attr(feature = "nightly", plugin(serde_macros))] #![allow(unused_imports, unused_mut, dead_code)] #[cfg(feature = "nightly")] include!("lib.rs.in"); #[cfg(feature = "with-serde-codegen")] include!(concat!(env!("OUT_DIR"), "/lib.rs"));