Struct google_api_proto::google::maps::regionlookup::v1alpha::RegionIdentifier

pub struct RegionIdentifier {
    pub place_type: i32,
    pub language_code: String,
    pub region_code: String,
    pub location: Option<Location>,
}

Region Identifier.

Identifies a region to look up.

One of place or unit_code must be specified. If none is specified, an INVALID_ARGUMENT error is returned. region_code must also be specified except when place_type is “country”.

place and unit_code specify a location to match a Place ID to. For example if place is “California” and region_code “US” the API returns the following matched_place_id results when the following place_types are specified:

place_type: matched_place_id results: administrative_area_level_1 Place ID for The State of California (All other supported types) No Match

If unit_code is “6” (FIPs code for California) and region_code is “US the API returns the following matched_place_id results when the following place_types are specified:

place type: matched_place_id results: administrative_area_level_1 Place ID for The State of California (All other supported types) No Match

or if unit_code is “US” the API returns the following results when the following place_types are specified:

place type: matched_place_id results: country Place ID for the United States (All other supported types) No Match

If no match is found, matched_place_id is not set.

Candidate Place IDs are returned when a lookup finds a region with a different place_type then the one requested. For example if place is “California” and place_type is “country” the Place ID for The State of California is returned as a candidate in the candidate_place_ids field.

Next available tag: 10

Fields

place_type: i32

Required. Place type to match.

language_code: String

The BCP-47 language code, such as “en-US” or “sr-Latn”, corresponding to the language in which the place name and address is requested. If none is requested, then it defaults to English.

region_code: String

Two-letter ISO-3166 country/region code for the location you’re trying to match. region_code is optional if place_type is “country”.

location: Option<Location>

The location must be specified by one of the following:

Implementations

impl RegionIdentifier

pub fn place_type(&self) -> PlaceType

Returns the enum value of place_type, or the default if the field is set to an invalid enum value.

pub fn set_place_type(&mut self, value: PlaceType)

Sets place_type to the provided enum value.

Trait Implementations

impl Clone for RegionIdentifier

fn clone(&self) -> RegionIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegionIdentifier

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

Formats the value using the given formatter.

impl Default for RegionIdentifier

fn default() -> Self

Returns the “default value” for a type.

impl Message for RegionIdentifier

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RegionIdentifier

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RegionIdentifier