Enum SubaddressType

pub enum SubaddressType {
    Apartment,
    Basement,
    Building,
    Department,
    Floor,
    Front,
    Hanger,
    Key,
    Lobby,
    Lot,
    Lower,
    Office,
    Penthouse,
    Pier,
    Rear,
    Room,
    Side,
    Slip,
    Space,
    Stop,
    Suite,
    Trailer,
    Unit,
    Upper,
    Rec,
    Laundry,
}

The SubaddressType enum represents the subaddress type of an address. Valid type designations include the list of secondary unit designators in Appendix C2 of the United States Postal Service (USPS) Publication 28 - Postal Addressing Standards.

Variants

Apartment

Basement

Building

Department

Floor

Front

Hanger

Key

Lobby

Lot

Lower

Office

Penthouse

Pier

Rear

Room

Side

Slip

Space

Stop

Suite

Trailer

Unit

Upper

Rec

Recreation room. A shared space common to apartment complexes.

Laundry

Laundry room. A shared space common to apartment complexes.

Implementations

impl SubaddressType

pub fn upper(&self) -> String

The upper method converts the variant name to UPPERCASE case using convert_case::Case::Upper.

pub fn abbreviate(&self) -> String

The abbreviate method returns a String with the postal abbreviation of the subaddress type.

pub fn match_abbreviated(input: &str) -> Option<Self>

Matches subaddress types in the data that observe the official postal contraction. For subaddress types with a mix of abbreviations and alternative spellings, the match_mixed method will work better.

pub fn deserialize_abbreviated<'de, D: Deserializer<'de>>( de: D, ) -> Result<Option<Self>, D::Error>

Deserialization function for subaddress types. This works if all the subaddress types in the data observe the official postal contraction. For subaddress types with a mix of abbreviations and alternative spellings, Self::match_mixed will work better.

pub fn match_mixed(input: &str) -> Option<Self>

Matches the target data against novel spellings of valid subaddress types. Add any missing spelling variants to the match statement. Called by [crate::Parser::subaddress_type]. Add additional variants to accommodate alternative abbreviations as needed.

pub fn deserialize_mixed<'de, D: Deserializer<'de>>( de: D, ) -> Result<Option<Self>, D::Error>

The deserialize_mixed_subaddress_type function attempts to deserialize the input data into a SubaddressType.

Trait Implementations

impl Clone for SubaddressType

fn clone(&self) -> SubaddressType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubaddressType

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

Formats the value using the given formatter.

impl Default for SubaddressType

fn default() -> SubaddressType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubaddressType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SubaddressType

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

Formats the value using the given formatter.

impl FromStr for SubaddressType

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, FromStrError>

Parses a string s to return a value of this type.

impl Hash for SubaddressType

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 IntoEnumIterator for SubaddressType

type Iterator = SubaddressTypeIter

fn iter() -> SubaddressTypeIter

impl Ord for SubaddressType

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SubaddressType

impl Eq for SubaddressType

impl StructuralPartialEq for SubaddressType