Skip to main content

Address

Struct Address 

Source
#[non_exhaustive]
pub struct Address {
Show 13 fields pub at_type: Option<String>, pub components: Option<Vec<AddressComponent>>, pub is_ordered: Option<bool>, pub country_code: Option<String>, pub coordinates: Option<String>, pub time_zone: Option<String>, pub contexts: Option<HashMap<String, bool>>, pub full: Option<String>, pub default_separator: Option<String>, pub pref: Option<u32>, pub phonetic_script: Option<String>, pub phonetic_system: Option<String>, pub extra: Map<String, Value>,
}
Expand description

A postal or geographic address (RFC 9553 §2.5.1).

At least one of components, coordinates, country_code, full, or time_zone must be set per the RFC; this is not enforced at the type level.

Distinct from the JMAP Mail RFC 8621 §3.2 submission-address type jmap_mail_types::Address: that type is an RFC 5321 SMTP envelope address with email and parameters, whereas this Address is a JSContact postal-address sub-object embedded in a ContactCard.addresses map.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§at_type: Option<String>

Object type discriminator; SHOULD be "Address" when present per RFC 9553 §1.3.4 (may be omitted in defaultType positions).

§components: Option<Vec<AddressComponent>>

The components making up this address.

§is_ordered: Option<bool>

Whether components are ordered (default false).

§country_code: Option<String>

ISO 3166-1 Alpha-2 country code.

§coordinates: Option<String>

geo: URI for the address (RFC 5870).

§time_zone: Option<String>

IANA time zone name for the address.

§contexts: Option<HashMap<String, bool>>

Contexts (key → true); extra keys beyond common contexts are "billing" and "delivery".

§full: Option<String>

The full address as a single string.

§default_separator: Option<String>

Default separator between component values when concatenating.

§pref: Option<u32>

Preference order in 1..=100 (lower = more preferred).

§phonetic_script: Option<String>

Phonetic script for component phonetics.

§phonetic_system: Option<String>

Phonetic system for component phonetics.

§extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

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<'de> Deserialize<'de> for Address

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Address

Source§

impl PartialEq for Address

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Address

Source§

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

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.