Enum PostalCommunity

pub enum PostalCommunity {
    GrantsPass,
    Medford,
    Merlin,
}

The PostalCommunity enum holds valid variants for the postal community field of an address. The list of valid postal communities is limited to the set of communities encountered locally, and we add new variants as needed.

This enum exists to facilitate parsing addresses. Because street names and types can parse ambiguously, it can be unclear during a parse whether a word should be parsed as a street name, street type or postal community. By ensuring the postal community maps to a valid value, we can reduce the risk of parsing a word to the wrong address element.

Variants

GrantsPass

The City of Grants Pass, an incorporated municipality and unincorporated community.

Medford

The City of Medford, an incorporated municipality.

Merlin

The City of Merlin, an unincorporated community.

Implementations

impl PostalCommunity

pub fn label(&self) -> String

The label method returns the name of the community in all caps with spaces, for printing labels.

use destination::PostalCommunity;

let city = PostalCommunity::GrantsPass;

assert_eq!(&city.label(), "GRANTS PASS");

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

The match_mixed method attempts to match the string input against a variant of PostalCommunity. Used to parse the postal community from an address blob.

use destination::PostalCommunity;

let a = PostalCommunity::match_mixed("Grants Pass").unwrap();
let b = PostalCommunity::match_mixed("GP").unwrap();

assert_eq!(a, b);

Trait Implementations

impl Clone for PostalCommunity

fn clone(&self) -> PostalCommunity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostalCommunity

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

Formats the value using the given formatter.

impl Default for PostalCommunity

fn default() -> PostalCommunity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PostalCommunity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PostalCommunity

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

Formats the value using the given formatter.

impl FromStr for PostalCommunity

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 PostalCommunity

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 PostalCommunity

type Iterator = PostalCommunityIter

fn iter() -> PostalCommunityIter

impl Ord for PostalCommunity

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

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

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

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 PostalCommunity

impl Eq for PostalCommunity

impl StructuralPartialEq for PostalCommunity