Struct Request 

pub struct Request<'a> { /* private fields */ }

Look at this Request struct for documentation on how to build your Time Zone API query. The methods implemented for this struct are what’s used to build your request.

Implementations

impl<'r> Request<'r>

pub fn build(&'r mut self) -> Result<&'r mut Self, Error>

👎Deprecated since 3.8.0: try using the query_string method instead

Builds the URL query string for the HTTP GET request.

Arguments

This method accepts no arguments.

Notes

• The query string is the part of the URL after the ? question mark. For example, in the URL https://example.com/over/there?name=ferret the query string is name=ferret

• The build method has been removed. It would store the generated query string inside of the request structure.

  This way, the same query string would only have to be generated once and could be used for any subsequent retries. This increased implementation complexity but had very performance little benefit. It has been removed.

  If you want to generate a query string (without the preceding URL), try the query_string method.

impl<'r> Request<'r>

pub const fn new( client: &'r Client, location: LatLng, timestamp: DateTime<Utc>, ) -> Self

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

Arguments

• client ‧ Your application’s Google Maps API client struct.

• location ‧ Latitude & longitude of the desired time zone location.

• timestamp ‧ Time is used to determine if Daylight Savings is applicable.

Example

use google_maps::prelude::TimeZoneRequest;
use google_maps::{LatLng, NaiveDate};

let time_zone = TimeZoneRequest::new(
    &my_settings,
    // St. Vitus Cathedral in Prague, Czechia
    LatLng::try_from_dec(50.090_903, 14.400_512)?,
    // Tuesday February 15, 2022 @ 6:00:00 pm
    NaiveDate::from_ymd(2022, 2, 15).and_hms(18, 00, 0)
).execute();

impl Request<'_>

pub fn with_language(self, language: impl Into<Language>) -> Self

Adds the language parameter to the Time Zone API query.

Arguments

• language ‧ The language that Google’s response should be presented in.

Example

• Set Google’s response to the French language:

.with_language(Language::French)

impl Request<'_>

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

Executes the Google Maps Time Zone API request.

Description

This method will:

1. Validate the request struct that has been built,

2. Build a URL and query string for an HTTP GET request,

3. Perform the HTTP GET request using the reqwest crate.

Arguments

This method accepts no arguments.

Errors

This method can fail if:

• This can fail if the request struct fails validation. For example, parameters in the request conflict with one another, or the request parameters are set in a way that’s incompatible.

  For example, Google Maps Directions API cannot calculate alternative routes if waypoints have been set. This will cause a validation failure.

• The HTTP client cannot make a connection to the Google Maps API server, or successfully send the request or receive the resposne over the network.

• The Google Maps API server returns an unexpected response, or data in a format that’s not expected.

impl Request<'_>

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

👎Deprecated since 3.8.0: try using execute instead

Performs the HTTP get request and returns the response.

Arguments

This method accepts no arguments.

Notes

• The get method for this request has been moved to a get method that’s been generically implemented for all APIs and services, implemented on the google_maps::Client struct.

  Try using execute method for a somewhat similar result. The main difference is that the execute method will validate the request and build the URL string, whereas the previous get implementation (that’s been deprecated) would blindly submit the request, if any.

Trait Implementations

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl EndPoint for Request<'_>

Defines a Google Maps API HTTP end-point for a request.

This trait returns information needed to make connect HTTP GET requests to their API end-point. It also includes some extra information for debugging and rating-limiting.

fn service_url() -> &'static str

URL for the HTTP end-point. For example, https://maps.googleapis.com/maps/api/directions. This string will be used to build the HTTP requests.

fn title() -> &'static str

Title of the API request end-point. For example Directions API or Elevation API. This title will be output in tracing messages.

fn apis() -> &'static [Api]

Returns which APIs are being used. This is used for rate-limiting on an API-basis.

fn output_format() -> Option<&'static str>

Google Maps accepts xml and json formats. Currently, this crate only supports the json format and this function should only return json for now.

impl QueryString for Request<'_>

fn query_string(&self) -> String

Builds the URL query string for the HTTP GET request. The query string is generated from the data found in this Request structure.

Arguments

This method accepts no arguments.

Notes

• This function does not validate the request before generating the query string. However, the superior method that generates the query URL does perform validation.

• The query string is the part of the URL after the ? question mark. For example, in the URL https://example.com/over/there?name=ferret the query string is name=ferret

• There’s no benefit to working on an owned Request struct (i.e. an owned self versus an borrowed &self). percent-encoding works on borrowed UTF-8 strings. Other types, such as enums and numeric values are converted into strings. Therefore no zero-copy operations are possible with an owned self.

impl RequestHeaders for Request<'_>

fn request_headers(&self) -> HeaderMap

Returns a map of HTTP header names to values.

These headers will be added to the HTTP request alongside the standard headers like Content-Type.

This API end-point does not use headers so it returns an empty hash map.

fn send_x_goog_api_key() -> bool

Returns whether the X-Goog-Api-Key header should be set for this request.

impl Validatable for Request<'_>

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

Ensures that the request is valid.

Arguments

This method accepts no arguments.

Errors

• This trait implementation is required for operation but there are currently no validations performed for this request type. This method will always return Ok.