Struct CustomSearchAPI

pub struct CustomSearchAPI<C> {
    pub client: Client<C>,
    pub auth: Box<dyn GetToken>,
    /* private fields */
}

Central instance to access all CustomSearchAPI related resource activities

Examples

Instantiate a new hub

extern crate hyper;
extern crate hyper_rustls;
extern crate google_customsearch1 as customsearch1;
use customsearch1::{Result, Error};
use customsearch1::{CustomSearchAPI, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: yup_oauth2::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 = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http1()
        .build()
);
let mut hub = CustomSearchAPI::new(client, 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.cse().siterestrict_list()
             .start(81)
             .sort("vero")
             .snippet_length(-76)
             .site_search_filter("invidunt")
             .site_search("Stet")
             .search_type("vero")
             .safe("elitr")
             .rights("Lorem")
             .related_site("diam")
             .q("no")
             .or_terms("ipsum")
             .num(-23)
             .lr("takimata")
             .low_range("consetetur")
             .link_site("voluptua.")
             .img_type("et")
             .img_size("erat")
             .img_dominant_color("consetetur")
             .img_color_type("amet.")
             .hq("sed")
             .hl("takimata")
             .high_range("dolores")
             .googlehost("gubergren")
             .gl("et")
             .filter("accusam")
             .file_type("voluptua.")
             .exclude_terms("dolore")
             .exact_terms("dolore")
             .date_restrict("dolore")
             .cx("voluptua.")
             .cr("amet.")
             .c2coff("ea")
             .doit().await;

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::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Fields

client: Client<C>

auth: Box<dyn GetToken>

Implementations

impl<'a, C> CustomSearchAPI<C>

pub fn new<A: 'static + GetToken>( client: Client<C>, auth: A, ) -> CustomSearchAPI<C>

pub fn cse(&'a self) -> CseMethods<'a, C>

pub fn user_agent(&mut self, agent_name: String) -> String

Set the user-agent header field to use in all requests to the server. It defaults to google-api-rust-client/6.0.0.

Returns the previously set user-agent.

pub fn base_url(&mut self, new_base_url: String) -> String

Set the base url to use in all requests to the server. It defaults to https://customsearch.googleapis.com/.

Returns the previously set base url.

pub fn root_url(&mut self, new_root_url: String) -> String

Set the root url to use in all requests to the server. It defaults to https://customsearch.googleapis.com/.

Returns the previously set root url.

Trait Implementations

impl<C: Clone> Clone for CustomSearchAPI<C>

fn clone(&self) -> CustomSearchAPI<C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C> Hub for CustomSearchAPI<C>