Struct PartialAddress

pub struct PartialAddress {

    pub address_number: Option<i64>,
    pub address_number_suffix: Option<String>,
    pub street_name_pre_directional: Option<StreetNamePreDirectional>,
    pub pre_modifier: Option<StreetNamePreModifier>,
    pub pre_type: Option<StreetNamePreType>,
    pub separator: Option<StreetSeparator>,
    pub street_name: Option<String>,
    pub street_name_post_type: Option<StreetNamePostType>,
    pub subaddress_type: Option<SubaddressType>,
    pub subaddress_identifier: Option<String>,
    pub floor: Option<i64>,
    pub building: Option<String>,
    pub zip_code: Option<i64>,
    pub postal_community: Option<PostalCommunity>,
    pub state_name: Option<State>,
    pub status: Option<AddressStatus>,
}

The PartialAddress struct contains optional fields so that incomplete or missing data can be compared against Addresses or PartialAddresses for potential matches. Used to help match address information that does not parse into a full valid address.

Fields

address_number: Option<i64>

The address_number field represents the address number component of the complete address number.

address_number_suffix: Option<String>

The number_suffix field represents the address number suffix component of the complete address number.

street_name_pre_directional: Option<StreetNamePreDirectional>

The directional field represents the street name pre directional component of the complete street name.

pre_modifier: Option<StreetNamePreModifier>

The pre_modifier field represents the street name pre modifier component of the complete street name.

pre_type: Option<StreetNamePreType>

The pre_type field represents the street name pre type component of the complete street name.

separator: Option<StreetSeparator>

The separator field represents the separator element component of the complete street name.

street_name: Option<String>

The street_name field represents the street name component of the complete street name.

street_name_post_type: Option<StreetNamePostType>

The street_type field represents the street name post type component of the complete street name.

subaddress_type: Option<SubaddressType>

The subaddress_type field represents the subaddress type component of the complete subaddress.

subaddress_identifier: Option<String>

The subaddress_id field represents the subaddress identifier component of the complete subaddress.

floor: Option<i64>

The floor field represents the floor identifier, corresponding to the Floor field from the NENA standard.

building: Option<String>

The building field represents the building identifier, corresponding to the Building field from the NENA standard.

zip_code: Option<i64>

The zip field represents the postal zip code of the address.

postal_community: Option<PostalCommunity>

The postal_community field represents the postal community component of the address, being either the unincorporated or incorporated municipality name.

state_name: Option<State>

The state field represents the state name component of the address.

status: Option<AddressStatus>

The status field represents the local status of the address as determined by the relevant addressing authority.

Implementations

impl PartialAddress

pub fn new() -> Self

Creates an empty new PartialAddress with all fields set to None.

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

The address_number field represents the address number component of the complete address number. This function returns the value of the field.

pub fn address_number_suffix(&self) -> Option<String>

The address_number_suffix field represents the address number suffix component of the complete address number. This function returns the cloned value of the field.

pub fn street_name_pre_directional(&self) -> Option<StreetNamePreDirectional>

The street_name_pre_directional field represents the street name predirectional component of the complete street name. This function returns the cloned value of the field.

pub fn pre_modifier(&self) -> Option<StreetNamePreModifier>

The pre_modifier field represents the street name premodifier component of the complete street name. This function returns the cloned value of the field.

pub fn pre_type(&self) -> Option<StreetNamePreType>

The pre_type field represents the street name pretype component of the complete street name. This function returns the cloned value of the field.

pub fn separator(&self) -> Option<StreetSeparator>

The separator field represents the street name separator component of the complete street name. This function returns the cloned value of the field.

pub fn street_name(&self) -> Option<String>

The street_name field represents the street name component of the complete street name. This function returns the cloned value of the field.

pub fn street_name_post_type(&self) -> Option<StreetNamePostType>

The street_name_post_type field represents the street name posttype component of the complete street name. This function returns the cloned value of the field.

pub fn subaddress_type(&self) -> Option<SubaddressType>

The subaddress_type field represents the subaddress type component of the complete subaddress. This function returns the cloned value of the field.

pub fn subaddress_identifier(&self) -> Option<String>

The subaddress_identifier field represents the subaddress identifier component of the complete subaddress. This function returns the cloned value of the field.

pub fn building(&self) -> Option<String>

The building field represents the unique identifier for a building. This function returns the cloned value of the field.

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

The floor field represents the floor of the building on which the address point is located. This function returns the value of the field.

pub fn set_address_number(&mut self, value: i64)

Sets the value of the address_number field to Some(value).

pub fn set_address_number_suffix(&mut self, value: Option<&str>)

Sets the value of the address_number_suffix field to Some(value).

pub fn set_pre_directional(&mut self, value: &StreetNamePreDirectional)

Sets the value of the street_name_pre_directional field to Some(value).

pub fn set_street_name(&mut self, value: &str)

Sets the value of the street_name field to Some(value).

pub fn set_post_type(&mut self, value: &StreetNamePostType)

Sets the value of the street_name_post_type field to Some(value).

pub fn set_subaddress_type(&mut self, value: &SubaddressType)

Sets the value of the subaddress_type field to Some(value).

pub fn set_subaddress_identifier(&mut self, value: &str)

Sets the value of the subaddress_identifier field to Some(value).

pub fn label(&self) -> String

Returns a String representing the address label, consisting of the complete address number, complete street name and complete subaddress, used to produce map or mailing labels.

pub fn mailing(&self) -> String

The mailing method prints the label format of the address, including postal community, state and zip code.

pub fn complete_address(&self) -> String

Returns a String representing the address label, consisting of the complete address number, complete street name and complete subaddress, used for the fully-disambiguated representation.

pub fn standardize(&mut self)

The standardize method takes county address naming conventions and converts them to city naming conventions.

Trait Implementations

impl Clone for PartialAddress

fn clone(&self) -> PartialAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartialAddress

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

Formats the value using the given formatter.

impl Default for PartialAddress

fn default() -> PartialAddress

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PartialAddress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PartialAddress

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 PartialAddress

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

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

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

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 PartialAddress

impl StructuralPartialEq for PartialAddress