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

//! **Look in this module for documentation on building your _Snap To Roads_
//! query**. In particular, look at the _Request_ struct for examples of the
//! builder pattern. This module contains the tools (enums, structs, methods)
//! for building your Google Maps Platform request.

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

mod build;
#[cfg(feature = "enable-reqwest")]
mod execute;
#[cfg(feature = "enable-reqwest")]
mod get;
mod new;
mod query_url;
mod with_interpolation;

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

use crate::client::GoogleMapsClient;
use crate::types::LatLng;

// -----------------------------------------------------------------------------
//
/// **Look at this `Request` struct for documentation on how to build your _Snap
/// To Roads_ query**. The methods implemented for this struct are what's used
/// to build your request.

#[derive(Debug)]
pub struct Request<'a> {
    // Required parameters:
    // --------------------
    /// This structure contains the application's API key and other
    /// user-definable settings such as "maximum retries."
    client: &'a GoogleMapsClient,

    /// The path to be snapped. The path parameter accepts a list of
    /// latitude/longitude pairs. Latitude and longitude values should be
    /// separated by commas. Coordinates should be separated by the pipe
    /// character: "|". For example:
    /// `path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796`.
    path: Vec<LatLng>,

    // Optional parameters:
    // --------------------
    /// Whether to interpolate a path to include all points forming the full
    /// road-geometry. When `true`, additional interpolated points will also be
    /// returned, resulting in a path that smoothly follows the geometry of the
    /// road, even around corners and through tunnels. Interpolated paths will
    /// most likely contain more points than the original path. Defaults to
    /// `false`.
    interpolate: Option<bool>,

    // Internal use only:
    // ------------------
    /// Query string that is to be submitted to the Google Cloud Maps Platform.
    query: Option<String>,
} // struct