Skip to main content

Address

relay_core::identity

Struct Address

pub struct Address {
    pub inbox: Option<InboxId>,
    pub user: UserId,
    pub agent: AgentId,
}

Fields§

§inbox: Option<InboxId>§user: UserId§agent: AgentId

Implementations§

impl Address

pub fn new(inbox: Option<InboxId>, user: UserId, agent: AgentId) -> Self

Creates a new address.

pub fn parse(input: impl AsRef<str>) -> Result<Self, Err>

Parse an address from a string. https://gitlab.com/relay-mail/docs/-/wikis/Architecture/Identity#address General format: [inbox]#user@agent

§Example

use relay_core::id::{Address, AgentId, InboxId, UserId};

let address = Address::parse("work#alice.smith@example.com").unwrap();
assert_eq!(address.inbox, Some(InboxId::parse("work").unwrap()));
assert_eq!(address.user, UserId::parse("alice.smith").unwrap());
assert_eq!(address.agent, AgentId::parse("example.com").unwrap());

pub fn canonical(&self) -> String

Get the canonical string representation of the address. https://gitlab.com/relay-mail/docs/-/wikis/Architecture/Identity#canonical-form

pub fn inbox(&self) -> Option<&InboxId>

Get inbox id.

pub fn user(&self) -> &UserId

Get user id.

pub fn agent(&self) -> &AgentId

Get agent id.

Trait Implementations§

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Address

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Address

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for Address

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

Formats the value using the given formatter. Read more

impl From<Address> for AgentId

fn from(address: Address) -> Self

Converts to this type from the input type.

impl From<Address> for UserId

fn from(address: Address) -> Self

Converts to this type from the input type.

impl Hash for Address

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for Address

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · 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.

impl Serialize for Address

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<&str> for Address

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Err>

Performs the conversion.

impl TryFrom<Address> for InboxId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(address: Address) -> Result<Self, Err>

Performs the conversion.

impl TryFrom<String> for Address

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Err>

Performs the conversion.

impl Eq for Address

impl StructuralPartialEq for Address

Auto Trait Implementations§

impl Freeze for Address

impl RefUnwindSafe for Address

impl Send for Address

impl Sync for Address

impl Unpin for Address

impl UnwindSafe for Address

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,