Struct Postcode 

pub struct Postcode(/* private fields */);

A well-formed postcode, held in its compact upper-case form.

Well formed is not the same as assigned: only the NIPOST API knows whether a code belongs to a real building.

Implementations

impl Postcode

pub fn parse(input: &str) -> Result<Self, ParseError>

Parses a hyphenated, spaced or compact code in either case.

pub fn parse_lenient(input: &str) -> Result<Corrected, ParseError>

Parses like parse after swapping look-alike characters that cannot occur where they stand: 0 1 5 8 for O I S B where a letter is required, and the reverse (plus L for 1) where a digit is.

The result is well formed but may not be the code the user meant, so confirm it with them when corrections is not zero.

pub fn from_segments( state: &str, lga: &str, district: &str, area: &str, unit: &str, ) -> Result<Self, ParseError>

Builds a code from its segments, zero-filling the LGA and unit so that "1" becomes "01".

pub fn as_str(&self) -> &str

The compact form, EK01A03FK01. Store and compare this one.

pub fn to_spaced(&self) -> String

The spaced form shown to people, EK 01 A03 FK 01.

pub fn prefix(&self, through: Segment) -> String

The hyphenated code down to and including through, so prefix(Segment::Area) is EK-01-A03-FK.

pub fn truncate(&self, through: Segment) -> Prefix

The code cut off after through, as a value: truncate(Segment::Area) is the area this building is in.

pub fn segment(&self, segment: Segment) -> &str

pub fn state(&self) -> &str

pub fn lga(&self) -> &str

pub fn district(&self) -> &str

pub fn area(&self) -> &str

pub fn unit(&self) -> &str

Trait Implementations

impl Clone for Postcode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Postcode

impl Debug for Postcode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Postcode

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Postcode

The canonical hyphenated form, EK-01-A03-FK-01.

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

Formats the value using the given formatter.

impl Eq for Postcode

impl From<Postcode> for Prefix

fn from(code: Postcode) -> Self

Converts to this type from the input type.

impl FromStr for Postcode

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Postcode

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 Postcode

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Postcode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Postcode

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

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Postcode