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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
//! **Look in this module for documentation on building your _Places API_
//! _Place Autocomplete_ 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.
pub mod autocomplete_type;
mod build;
#[cfg(feature = "enable-reqwest")]
mod execute;
#[cfg(feature = "enable-reqwest")]
mod get;
mod new;
mod query_url;
mod with_components;
mod with_language;
mod with_location;
mod with_offset;
mod with_origin;
mod with_region;
mod with_sessiontoken;
mod with_types;
// -----------------------------------------------------------------------------
use crate::client::GoogleMapsClient;
use crate::places::place_autocomplete::request::autocomplete_type::AutocompleteType;
use crate::types::{Country, Language, LatLng, Region};
// -----------------------------------------------------------------------------
/// **Look at this `Request` struct for documentation on how to build your
/// _Place Autocomplete_ 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 text string on which to search. The Place Autocomplete service will
/// return candidate matches based on this string and order results based on
/// their perceived relevance.
input: String,
// Optional parameters:
// --------------------
/// A grouping of places to which you would like to restrict your results.
/// Currently, you can use components to filter by up to 5 countries.
///
/// * **Note**: If you receive unexpected results with a country code,
/// verify that you are using a code which includes the countries, dependent
/// territories, and special areas of geographical interest you intend. You
/// can find code information at [Wikipedia: List of ISO 3166 country
/// codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) or
/// the [ISO Online Browsing Platform](https://www.iso.org/obp/ui/#search).
components: Vec<Country>,
/// The language in which to return results.
///
/// * See the list of supported languages. Google often updates the
/// supported languages, so this list may not be exhaustive.
///
/// * If `language` is not supplied, the API attempts to use the preferred
/// language as specified in the `Accept-Language` header.
///
/// * The API does its best to provide a street address that is readable for
/// both the user and locals. To achieve that goal, it returns street
/// addresses in the local language, transliterated to a script readable by
/// the user if necessary, observing the preferred language. All other
/// addresses are returned in the preferred language. Address components are
/// all returned in the same language, which is chosen from the first
/// component.
///
/// * If a name is not available in the preferred language, the API uses the
/// closest match.
///
/// * The preferred language has a small influence on the set of results
/// that the API chooses to return, and the order in which they are
/// returned. The geocoder interprets abbreviations differently depending on
/// language, such as the abbreviations for street types, or synonyms that
/// may be valid in one language but not in another. For example, _utca_ and
/// _tér_ are synonyms for street in Hungarian.
language: Option<Language>,
/// The point around which to retrieve place information.
///
/// * When using the Text Search API, the 'location' parameter may be
/// overriden if the 'query' contains an explicit location such as
/// 'Market in Barcelona'.
location: Option<LatLng>,
/// The position, in the input term, of the last character that the service
/// uses to match predictions. For example, if the input is `Google` and the
/// offset is 3, the service will match on `Goo`. The string determined by
/// the offset is matched against the first word in the input term only.
/// For example, if the input term is `Google abc` and the offset is 3, the
/// service will attempt to match against `Goo abc`. If no offset is
/// supplied, the service will use the whole term. The offset should
/// generally be set to the position of the text caret.
offset: Option<u8>,
/// The origin point from which to calculate straight-line distance to the
/// destination (returned as `distance_meters`). If this value is omitted,
/// straight-line distance will not be returned.
origin: Option<LatLng>,
/// Defines the distance (in meters) within which to return place results.
/// You may bias results to a specified circle by passing a location and a
/// radius parameter. Doing so instructs the Places service to prefer
/// showing results within that circle; results outside of the defined area
/// may still be displayed.
///
/// The radius will automatically be clamped to a maximum value depending on
/// the type of search and other parameters.
///
/// * Autocomplete: 50,000 meters
/// * Nearby Search:
/// * with `keyword` or `name`: 50,000 meters
/// * without `keyword` or `name`
/// * Up to 50,000 meters, adjusted dynamically based on area
/// density, independent of `rankby` parameter.
/// * When using `rankby=distance`, the radius parameter will not be
/// accepted, and will result in an `INVALID_REQUEST`.
/// * Query Autocomplete: 50,000 meters
/// * Text Search: 50,000 meters
radius: Option<u32>,
/// The region code, specified as a [ccTLD ("top-level
/// domain")](https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains)
/// two-character value. Most ccTLD codes are identical to ISO 3166-1 codes,
/// with some notable exceptions. For example, the United Kingdom's ccTLD is
/// "uk" (.co.uk) while its ISO 3166-1 code is "gb" (technically for the
/// entity of "The United Kingdom of Great Britain and Northern Ireland").
region: Option<Region>,
/// A random string which identifies an autocomplete
/// [session](https://developers.google.com/maps/documentation/places/web-service/details#session_tokens)
/// for billing purposes.
///
/// The session begins when the user starts typing a query, and concludes
/// when they select a place and a call to Place Details is made. Each
/// session can have multiple queries, followed by one place selection. The
/// API key(s) used for each request within a session must belong to the
/// same Google Cloud Console project. Once a session has concluded, the
/// token is no longer valid; your app must generate a fresh token for each
/// session. If the `sessiontoken` parameter is omitted, or if you reuse a
/// session token, the session is charged as if no session token was
/// provided (each request is billed separately).
///
/// We recommend the following guidelines:
///
/// * Use session tokens for all autocomplete sessions.
///
/// * Generate a fresh token for each session. Using a version 4 UUID is
/// recommended.
///
/// * Ensure that the API key(s) used for all Place Autocomplete and Place
/// Details requests within a session belong to the same Cloud Console
/// project.
///
/// * Be sure to pass a unique session token for each new session. Using the
/// same token for more than one session will result in each request being
/// billed individually.
sessiontoken: Option<String>,
/// Returns only those places that are strictly within the region defined by
/// `location` and `radius`. This is a restriction, rather than a bias,
/// meaning that results outside this region will not be returned even if
/// they match the user input.
strictbounds: Option<bool>,
/// You may restrict results from a Place Autocomplete request to be of a
/// certain type by passing a types parameter. The parameter specifies a
/// type or a type collection, as listed in the supported types below. If
/// nothing is specified, all types are returned. In general only a single
/// type is allowed. The exception is that you can safely mix the geocode
/// and establishment types, but note that this will have the same effect as
/// specifying no types.
types: Vec<AutocompleteType>,
// Internal use only:
// ------------------
/// Query string that is to be submitted to the Google Cloud Maps Platform.
query: Option<String>,
} // struct