Struct AutocompleteInput

#[non_exhaustive]
pub struct AutocompleteInput {
    pub query_text: Option<String>,
    pub max_results: Option<i32>,
    pub bias_position: Option<Vec<f64>>,
    pub filter: Option<AutocompleteFilter>,
    pub postal_code_mode: Option<PostalCodeMode>,
    pub additional_features: Option<Vec<AutocompleteAdditionalFeature>>,
    pub language: Option<String>,
    pub political_view: Option<String>,
    pub intended_use: Option<AutocompleteIntendedUse>,
    pub key: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query_text: Option<String>

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

The fields QueryText, and QueryID are mutually exclusive.

max_results: Option<i32>

An optional limit for the number of results returned in a single call.

bias_position: Option<Vec<f64>>

The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in \[lng, lat\] and in the WSG84 format.

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

filter: Option<AutocompleteFilter>

A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

postal_code_mode: Option<PostalCodeMode>

The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities, all cities in that postal code are returned.

additional_features: Option<Vec<AutocompleteAdditionalFeature>>

A list of optional additional parameters that can be requested for each result.

language: Option<String>

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

political_view: Option<String>

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

The following political views are currently supported:

• ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

• EGY: Egypt's view on Bir Tawil

• IND: India's view on Gilgit-Baltistan

• KEN: Kenya's view on the Ilemi Triangle

• MAR: Morocco's view on Western Sahara

• RUS: Russia's view on Crimea

• SDN: Sudan's view on the Halaib Triangle

• SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

• SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

• SYR: Syria's view on the Golan Heights

• TUR: Turkey's view on Cyprus and Northern Cyprus

• TZA: Tanzania's view on Lake Malawi

• URY: Uruguay's view on Rincon de Artigas

• VNM: Vietnam's view on the Paracel Islands and Spratly Islands

intended_use: Option<AutocompleteIntendedUse>

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

key: Option<String>

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Implementations

impl AutocompleteInput

pub fn query_text(&self) -> Option<&str>

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

The fields QueryText, and QueryID are mutually exclusive.

pub fn max_results(&self) -> Option<i32>

An optional limit for the number of results returned in a single call.

pub fn bias_position(&self) -> &[f64]

The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in \[lng, lat\] and in the WSG84 format.

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bias_position.is_none().

pub fn filter(&self) -> Option<&AutocompleteFilter>

A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

pub fn postal_code_mode(&self) -> Option<&PostalCodeMode>

The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities, all cities in that postal code are returned.

pub fn additional_features(&self) -> &[AutocompleteAdditionalFeature]

A list of optional additional parameters that can be requested for each result.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_features.is_none().

pub fn language(&self) -> Option<&str>

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

pub fn political_view(&self) -> Option<&str>

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

The following political views are currently supported:

• ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

• EGY: Egypt's view on Bir Tawil

• IND: India's view on Gilgit-Baltistan

• KEN: Kenya's view on the Ilemi Triangle

• MAR: Morocco's view on Western Sahara

• RUS: Russia's view on Crimea

• SDN: Sudan's view on the Halaib Triangle

• SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

• SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

• SYR: Syria's view on the Golan Heights

• TUR: Turkey's view on Cyprus and Northern Cyprus

• TZA: Tanzania's view on Lake Malawi

• URY: Uruguay's view on Rincon de Artigas

• VNM: Vietnam's view on the Paracel Islands and Spratly Islands

pub fn intended_use(&self) -> Option<&AutocompleteIntendedUse>

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

pub fn key(&self) -> Option<&str>

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

impl AutocompleteInput

pub fn builder() -> AutocompleteInputBuilder

Creates a new builder-style object to manufacture AutocompleteInput.

Trait Implementations

impl Clone for AutocompleteInput

fn clone(&self) -> AutocompleteInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutocompleteInput

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

Formats the value using the given formatter.

impl PartialEq for AutocompleteInput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AutocompleteInput