Struct AddressComponent 

pub struct AddressComponent {
    pub component_name: ComponentName,
    pub component_type: String,
    pub confirmation_level: ConfirmationLevel,
    pub inferred: bool,
    pub spell_corrected: bool,
    pub replaced: bool,
    pub unexpected: bool,
}

Represents an address component, such as a street, city, or state.

The addressComponent property is a subcomponent of address which provides a detailed listing of the elements—or components—of the address that the Address Validation API has processed. The API identifies each component field provides by its name, type, and confirmation level.

Key Point

• Use the address property to obtain address formatting. Use its subcomponent addressComponent for investigating errors and providing information about those errors to your customers. However, don’t build your integration to rely on the specific confirmation level for address components. See Build your validation logic for integration guidance.

Fields

component_name: ComponentName

The name for this component.

component_type: String

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

confirmation_level: ConfirmationLevel

Indicates the level of certainty that we have that the component is correct.

inferred: bool

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

spell_corrected: bool

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing “centre” to “center”. It also does not always flag common misspellings, such as when changing “Amphitheater Pkwy” to “Amphitheatre Pkwy”.

replaced: bool

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

unexpected: bool

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

Implementations

impl AddressComponent

pub fn inferred(&self) -> bool

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

pub fn spell_corrected(&self) -> bool

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing “centre” to “center”. It also does not always flag common misspellings, such as when changing “Amphitheater Pkwy” to “Amphitheatre Pkwy”.

pub fn replaced(&self) -> bool

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

pub fn unexpected(&self) -> bool

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

impl AddressComponent

pub fn component_name(&self) -> &ComponentName

The name for this component.

pub fn component_type(&self) -> &String

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

pub fn confirmation_level(&self) -> &ConfirmationLevel

Indicates the level of certainty that we have that the component is correct.

impl AddressComponent

pub fn component_name_mut(&mut self) -> &mut ComponentName

The name for this component.

pub fn component_type_mut(&mut self) -> &mut String

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

pub fn confirmation_level_mut(&mut self) -> &mut ConfirmationLevel

Indicates the level of certainty that we have that the component is correct.

pub fn inferred_mut(&mut self) -> &mut bool

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

pub fn spell_corrected_mut(&mut self) -> &mut bool

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing “centre” to “center”. It also does not always flag common misspellings, such as when changing “Amphitheater Pkwy” to “Amphitheatre Pkwy”.

pub fn replaced_mut(&mut self) -> &mut bool

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

pub fn unexpected_mut(&mut self) -> &mut bool

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

impl AddressComponent

pub fn set_component_name(&mut self, val: ComponentName) -> &mut Self

The name for this component.

pub fn set_component_type(&mut self, val: String) -> &mut Self

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

pub fn set_confirmation_level(&mut self, val: ConfirmationLevel) -> &mut Self

Indicates the level of certainty that we have that the component is correct.

pub fn set_inferred(&mut self, val: bool) -> &mut Self

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

pub fn set_spell_corrected(&mut self, val: bool) -> &mut Self

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing “centre” to “center”. It also does not always flag common misspellings, such as when changing “Amphitheater Pkwy” to “Amphitheatre Pkwy”.

pub fn set_replaced(&mut self, val: bool) -> &mut Self

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

pub fn set_unexpected(&mut self, val: bool) -> &mut Self

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

Trait Implementations

impl Clone for AddressComponent

fn clone(&self) -> AddressComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressComponent

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

Formats the value using the given formatter.

impl Default for AddressComponent

fn default() -> AddressComponent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddressComponent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for AddressComponent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AddressComponent

fn cmp(&self, other: &AddressComponent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AddressComponent

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

fn partial_cmp(&self, other: &AddressComponent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AddressComponent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AddressComponent

impl StructuralPartialEq for AddressComponent