Struct google_maps::elevation::request::Request

pub struct Request { /* fields omitted */ }

Use this structure's methods to build a Time Zone API request.

Methods

impl Request

pub fn build(&mut self) -> Result<&mut Request, Error>

Builds the query string for the Google Maps Elevation API based on the input provided by the client.

Arguments:

This method accepts no arguments.

impl Request

pub fn execute(&mut self) -> Result<Response, Error>

Executes the query you've built.

Description:

You are not required to call the .validate()?.build()?.get()? chain at the end of your builder pattern. You may still wish to do so if you would like to manually control the method calls. For example, if you would like to omit validation. However, this .execute() method wraps all of these steps into a single method call for convenience.

Arguments:

This method accepts no arguments.

impl Request

pub fn get(&self) -> Result<Response, Error>

Performs the HTTP get request and returns the response to the caller.

Arguments:

This method accepts no arguments.

impl Request

pub fn new(key: String) -> Request

Initializes the builder pattern for a Elevation API query with the required, non-optional parameters.

Arguments:

• key - Your application's Google Cloud API key.

impl Request

pub fn positional_request(&mut self, locations: Locations) -> &mut Request

Adds the positional request parameters to the Elevation API query.

Arguments:

• path ‧ Defines a path on the earth for which to return elevation data. This parameter defines a set of two or more ordered latitude/longitude pairs defining a path along the surface of the earth. For more information, see Specifying Paths.

• samples ‧ Specifies the number of sample points along a path for which to return elevation data. The samples parameter divides the given path into an ordered set of equidistant points along the path.

Example:

let response = ElevationRequest::new(GOOGLE_API_KEY)
.positional_request(ElevationLocations::LatLngs(vec![
    // Denver, Colorado, the "Mile High City"
    LatLng { lat: 39.7391536, lng: -104.9847034 },
])).validate().unwrap().build().unwrap().get().unwrap();
let elevation = response.results.unwrap()[0].elevation;

impl Request

pub fn sampled_path_request(
    &mut self,
    path: Locations,
    samples: u8
) -> &mut Request

Adds the sampled path request parameters to the Elevation API query.

Arguments:

• locations ‧ Defines the location(s) on the earth from which to return elevation data. This parameter takes either a single location, as a latitude/longitude pair, multiple latitude/longitude pairs, or an encoded polyline. For more information, see Specifying Locations.

Example:

let elevation = ElevationRequest::new(GOOGLE_API_KEY)
.sampled_path_request(
    ElevationLocations::LatLngs(vec![
        // Denver, Colorado
        LatLng { lat: 40.714728, lng: -73.998672 },
        // Death Valley, California
        LatLng { lat: -34.397, lng: -116.866667 },
    ]),
    // Number of samples
    4
).validate().unwrap().build().unwrap().get().unwrap();

impl Request

pub fn validate(&mut self) -> Result<&mut Request, Error>

Ensures the built query is valid. This function checks the combination of parameters to ensure that they make sense together and that Google Maps Directions API will accept them - i.e. it will not allow both a Positional Request and a Sampled Path Request in the same query. This function does not check parameter values for validity - i.e. it will not ensure Polylines or Latitudes/Longitudes are valid and well-formed.

Arguments:

This method accepts no arguments.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Request> for Request

fn eq(&self, other: &Request) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Request) -> bool

This method tests for !=.

impl PartialOrd<Request> for Request

fn partial_cmp(&self, other: &Request) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Request) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Request) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Request) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Request) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Request

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Request