google_maps 3.9.5

An unofficial Google Maps Platform client library for the Rust programming language.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! Contains the `GoogleMapsClient` struct and its associated traits. Use its
//! implemented methods to set your _Google API key_ and other settings such as:
//! _rate limiting_, _maxium retries_, & _retry delay times_ for your requests.

// -----------------------------------------------------------------------------

mod build;
mod impls;

#[cfg(all(
    feature = "reqwest",
    any(
        feature = "address_validation",
        feature = "directions",
        feature = "distance_matrix",
        feature = "elevation",
        feature = "geocoding",
        feature = "time_zone",
        feature = "roads",
        // Places (Legacy) API:
        feature = "autocomplete",
        feature = "places",
        // Places (New) API:
        feature = "places-new-place-details",
        feature = "places-new-place-photos",
    )
))]
mod get_request;

#[cfg(all(feature = "reqwest", feature = "places-new-place-photos"))]
mod get_binary_request;

#[cfg(all(
    feature = "reqwest",
    any(
        feature = "places-new-core",
        feature = "address_validation",
    )
))]
mod post_request;

#[cfg(feature = "reqwest")]
mod with_rate;

#[cfg(feature = "reqwest")]
mod with_reqwest_client;

// -----------------------------------------------------------------------------

#[cfg(feature = "reqwest")]
use crate::request_rate::RequestRate;

// -----------------------------------------------------------------------------
//
/// Use the `GoogleMapsClient` struct's implemented methods to set your _Google
/// API key_ and other settings such as: _rate limiting_, _maxium retries_, &
/// _retry delay times_ for your requests.
///
/// This structure contains your API key - the preferred way for authenticating
/// with the Google Maps Platform APIs, your request rate limit settings, and
/// your automatic retry settings.
///
/// How to use this structure's methods in a builder pattern:
///
/// ```rust
/// let mut my_settings = google_maps::Client::try_new(YOUR_GOOGLE_API_KEY_HERE)
///     .with_max_delay(std::time::Duration::from_secs(32))
///     .with_max_retries(10)
///     .with_rate(&Api::All, 1, std::time::Duration::from_secs(2))
///     .build();
/// ```

#[derive(Clone, Debug)]
pub struct Client {
    /// Your application's API key. This key identifies your application for
    /// purposes of quota management. Learn how to [get a
    /// key](https://developers.google.com/maps/documentation/geocoding/get-api-key).
    pub key: String,

    /// Rate limits for each of the Google Cloud Maps Platform APIs.
    #[cfg(feature = "reqwest")]
    pub rate_limit: RequestRate,

    /// Allows you to optionally provide your own pre-configured reqwest client
    /// that will be used by the Google Maps client.
    #[cfg(all(feature = "reqwest", feature = "reqwest-middleware"))]
    pub reqwest_client: crate::reqwest_maybe_middleware::Client,

    /// Allows you to optionally provide your own pre-configured reqwest client
    /// that will be used by the Google Maps client.
    #[cfg(all(feature = "reqwest", not(feature = "reqwest-middleware")))]
    pub reqwest_client: reqwest::Client,
} // struct