Struct GeocodeResultItem 

#[non_exhaustive]
pub struct GeocodeResultItem {

    pub place_id: String,
    pub place_type: PlaceType,
    pub title: String,
    pub address: Option<Address>,
    pub address_number_corrected: Option<bool>,
    pub postal_code_details: Option<Vec<PostalCodeDetails>>,
    pub position: Option<Vec<f64>>,
    pub distance: i64,
    pub map_view: Option<Vec<f64>>,
    pub categories: Option<Vec<Category>>,
    pub food_types: Option<Vec<FoodType>>,
    pub access_points: Option<Vec<AccessPoint>>,
    pub time_zone: Option<TimeZone>,
    pub political_view: Option<String>,
    pub match_scores: Option<MatchScoreDetails>,
    pub parsed_query: Option<GeocodeParsedQuery>,
    pub intersections: Option<Vec<Intersection>>,
    pub main_address: Option<RelatedPlace>,
    pub secondary_addresses: Option<Vec<RelatedPlace>>,
}

The Geocoded result.

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.

place_id: String

The PlaceId of the place result.

place_type: PlaceType

A PlaceType is a category that the result place must belong to.

title: String

The localized display name of this result item based on request parameter language.

address: Option<Address>

The place's address.

address_number_corrected: Option<bool>

Boolean indicating if the address provided has been corrected.

postal_code_details: Option<Vec<PostalCodeDetails>>

Contains details about the postal code of the place/result.

position: Option<Vec<f64>>

The position in longitude and latitude.

distance: i64

The distance in meters from the QueryPosition.

map_view: Option<Vec<f64>>

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: \[{westward lng}, {southern lat}, {eastward lng}, {northern lat}\]

categories: Option<Vec<Category>>

Categories of results that results must belong to.

food_types: Option<Vec<FoodType>>

List of food types offered by this result.

access_points: Option<Vec<AccessPoint>>

Position of the access point represented by longitude and latitude.

time_zone: Option<TimeZone>

The time zone in which the place is located.

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.

match_scores: Option<MatchScoreDetails>

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

parsed_query: Option<GeocodeParsedQuery>

Free-form text query.

intersections: Option<Vec<Intersection>>

All Intersections that are near the provided address.

main_address: Option<RelatedPlace>

The main address corresponding to a place of type Secondary Address.

secondary_addresses: Option<Vec<RelatedPlace>>

All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

Implementations

impl GeocodeResultItem

pub fn place_id(&self) -> &str

The PlaceId of the place result.

pub fn place_type(&self) -> &PlaceType

A PlaceType is a category that the result place must belong to.

pub fn title(&self) -> &str

The localized display name of this result item based on request parameter language.

pub fn address(&self) -> Option<&Address>

The place's address.

pub fn address_number_corrected(&self) -> Option<bool>

Boolean indicating if the address provided has been corrected.

pub fn postal_code_details(&self) -> &[PostalCodeDetails]

Contains details about the postal code of the place/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 .postal_code_details.is_none().

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

The position in longitude and latitude.

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

pub fn distance(&self) -> i64

The distance in meters from the QueryPosition.

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

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: \[{westward lng}, {southern lat}, {eastward lng}, {northern lat}\]

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

pub fn categories(&self) -> &[Category]

Categories of results that results must belong to.

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

pub fn food_types(&self) -> &[FoodType]

List of food types offered by this 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 .food_types.is_none().

pub fn access_points(&self) -> &[AccessPoint]

Position of the access point represented by longitude and latitude.

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

pub fn time_zone(&self) -> Option<&TimeZone>

The time zone in which the place is located.

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 match_scores(&self) -> Option<&MatchScoreDetails>

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

pub fn parsed_query(&self) -> Option<&GeocodeParsedQuery>

Free-form text query.

pub fn intersections(&self) -> &[Intersection]

All Intersections that are near the provided address.

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

pub fn main_address(&self) -> Option<&RelatedPlace>

The main address corresponding to a place of type Secondary Address.

pub fn secondary_addresses(&self) -> &[RelatedPlace]

All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

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

impl GeocodeResultItem

pub fn builder() -> GeocodeResultItemBuilder

Creates a new builder-style object to manufacture GeocodeResultItem.

Trait Implementations

impl Clone for GeocodeResultItem

fn clone(&self) -> GeocodeResultItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeocodeResultItem

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

Formats the value using the given formatter.

impl PartialEq for GeocodeResultItem

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