Struct ReverseGeocodeInput 

#[non_exhaustive]
pub struct ReverseGeocodeInput {
    pub query_position: Option<Vec<f64>>,
    pub query_radius: Option<i64>,
    pub max_results: Option<i32>,
    pub filter: Option<ReverseGeocodeFilter>,
    pub additional_features: Option<Vec<ReverseGeocodeAdditionalFeature>>,
    pub language: Option<String>,
    pub political_view: Option<String>,
    pub intended_use: Option<ReverseGeocodeIntendedUse>,
    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_position: Option<Vec<f64>>

The position, in \[lng, lat\] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position

query_radius: Option<i64>

The maximum distance in meters from the QueryPosition from which a result will be returned.

max_results: Option<i32>

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

filter: Option<ReverseGeocodeFilter>

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

additional_features: Option<Vec<ReverseGeocodeAdditionalFeature>>

A list of optional additional parameters, such as time zone 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.

intended_use: Option<ReverseGeocodeIntendedUse>

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

Storing the response of an ReverseGeocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

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 ReverseGeocodeInput

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

The position, in \[lng, lat\] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position

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

pub fn query_radius(&self) -> Option<i64>

The maximum distance in meters from the QueryPosition from which a result will be returned.

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

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

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

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

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

A list of optional additional parameters, such as time zone 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.

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

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

Storing the response of an ReverseGeocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

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 ReverseGeocodeInput

pub fn builder() -> ReverseGeocodeInputBuilder

Creates a new builder-style object to manufacture ReverseGeocodeInput.

Trait Implementations

impl Clone for ReverseGeocodeInput

fn clone(&self) -> ReverseGeocodeInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReverseGeocodeInput

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

Formats the value using the given formatter.

impl PartialEq for ReverseGeocodeInput

fn eq(&self, other: &ReverseGeocodeInput) -> 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 ReverseGeocodeInput