Skip to main content

Address

Struct Address 

Source
pub struct Address {
    pub line1: String,
    pub line2: Option<String>,
    pub city: String,
    pub county: Option<String>,
    pub postcode: UkPostcode,
    pub country: CountryCode,
    pub coords: Option<Coords>,
}
Expand description

A validated postal address.

Validation:

  • line1 must be non-empty after trimming
  • city must be non-empty after trimming
  • postcode must be valid (already validated by its type)
  • country must be valid
  • line2 and county if Some must be non-empty after trimming
  • optional coords if Some must be valid

Fields§

§line1: String

First address line (required, non-empty).

§line2: Option<String>

Optional second address line.

§city: String

City / town (required, non-empty).

§county: Option<String>

Optional county / state / province.

§postcode: UkPostcode

Postcode / ZIP.

§country: CountryCode

ISO 3166-1 alpha-2 country code.

§coords: Option<Coords>

Optional coordinates.

Implementations§

Source§

impl Address

Source

pub fn new( line1: String, line2: Option<String>, city: String, county: Option<String>, postcode: UkPostcode, country: CountryCode, ) -> Result<Self, GeoError>

Create a validated address.

Validates that required string fields are non-empty after trimming and that optional string fields, if present, are non-empty after trimming.

§Errors

Returns GeoError::InvalidAddress if validation fails.

Source

pub fn new_with_coords( line1: String, line2: Option<String>, city: String, county: Option<String>, postcode: UkPostcode, country: CountryCode, coords: Option<Coords>, ) -> Result<Self, GeoError>

Create a validated address with optional coordinates.

§Errors

Returns GeoError::InvalidAddress if validation fails or GeoError::InvalidCoords via address error conversion if coords are invalid (coords are already validated on construction).

Source

pub fn line1(&self) -> &str

Return line1.

Source

pub fn city(&self) -> &str

Return city.

Source

pub fn postcode(&self) -> &UkPostcode

Return postcode.

Source

pub fn country(&self) -> &CountryCode

Return country.

Trait Implementations§

Source§

impl Clone for Address

Source§

fn clone(&self) -> Address

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Address

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Address

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Address

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Address

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.