Struct google_maps::client_settings::ClientSettings

pub struct ClientSettings {
    pub key: String,
    pub max_retries: u8,
    pub max_backoff: u32,
    pub rate_limit: RequestRate,
}

Contains information used for authenticating with Google and other settings.

Fields

key: String

Your application's API key. This key identifies your application for purposes of quota management. Learn how to get a key. Contains the application's API key and other settings.

max_retries: u8

Certain network & server-side errors may be successful if retried with the same payload. This parameter sets the maximum number of times the client should retry before giving up.

max_backoff: u32

It's okay to continue retrying once you reach the max_backoff time. Retries after this point do not need to continue increasing backoff time. For example, if a client uses an max_backoff time of 64 seconds, then after reaching this value, the client can retry every 64 seconds. At some point, clients should be prevented from retrying infinitely.

How long clients should wait between retries and how many times they should retry depends on your use case and network conditions. For example, mobile clients of an application may need to retry more times and for longer intervals when compared to desktop clients of the same application.

rate_limit: RequestRate

Rate limits for each of the Google Cloud Maps Platform APIs.

Methods

impl ClientSettings

pub fn finalize(&self) -> ClientSettings

Completes the builder pattern into a final structure.

Arguments:

This method accepts no arguments.

impl ClientSettings

pub fn new(key: &str) -> ClientSettings

Initialize the settings needed for a Google Cloud Maps API transaction.

impl ClientSettings

pub fn with_max_delay(&mut self, max_delay: Duration) -> &mut ClientSettings

Sets the maximum delay between request retries upon consecutive failures.

Arguments

• max_delay ‧ The maximum delay between request retries.

Description

Client will continue retrying once you the max_delay time is reached. Retries after this point will not continue increasing backoff time. For example, if a client uses an max_delay time of 64 seconds, then after reaching this value, the client can retry every 64 seconds.

How long clients should wait between retries and how many times they should retry depends on your use case and network conditions. For example, mobile clients of an application may need to retry more times and for longer intervals when compared to desktop clients of the same application.

Example:

• Sets the maximum delay between request retries to 32 seconds:

.with_max_delay(Api::All, Duration::seconds(32))

impl ClientSettings

pub fn with_max_retries(&mut self, max_retries: u8) -> &mut ClientSettings

Sets the maximum number of retries upon a series of request failures.

Arguments

• max_retries ‧ The maximum number of request retries.

Example:

• Sets the maximum number of retries to 10:

.with_max_retries(10)

impl ClientSettings

pub fn with_rate(
    &mut self,
    api: Api,
    requests: u16,
    per_duration: Duration
) -> &mut ClientSettings

Sets the rate limit for the specified API.

Arguments

• api ‧ Which Google Maps API are you setting the rate limit for? For example, Api::Directions, Api::DistanceMatrix, Api::Elevation, Api::Geocoding, Api::TimeZone, and so on. The Api::All rate limit is applied to all Google Maps API requests in addition to the per-API rate limits.

• requests ‧ Sets the maximum number of requests in the specified duration. For example, 2 requests per 1 hour.

• per_duration ‧ Sets the duration window that the requests should be measured against. For example, 1 request per 1 minute.

Examples:

• Sets the rate limit for all Google Maps API requests to 2 request per minute:

.with_rate(Api::All, 2, Duration::minutes(1))

• Sets the rate limit for Google Maps Elevation API requests to 1 requests per second:

.with_rate(Api::Elevation, 1, Duration::seconds(1))

• This method can be stacked:

.with_rate(Api::All, 1, Duration::seconds(1))
.with_rate(Api::Directions, 1, Duration::hours(1))
.with_rate(Api::TimeZone, 2, Duration::hours(1))

Trait Implementations

impl Clone for ClientSettings

fn clone(&self) -> ClientSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientSettings

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

Formats the value using the given formatter.

impl Eq for ClientSettings

impl Ord for ClientSettings

fn cmp(&self, other: &ClientSettings) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ClientSettings> for ClientSettings

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

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

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

This method tests for !=.

impl PartialOrd<ClientSettings> for ClientSettings

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ClientSettings

impl StructuralPartialEq for ClientSettings