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) -> Address

Creates a new address.

pub fn parse(input: impl AsRef<str>) -> Result<Address, IdentityError>

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.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl From<Address> for AgentId

fn from(address: Address) -> AgentId

Converts to this type from the input type.

impl From<Address> for UserId

fn from(address: Address) -> UserId

Converts to this type from the input type.

impl Hash for Address

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

where __H: Hasher,

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 PartialEq for Address

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Address

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Address, IdentityError>

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<InboxId, IdentityError>

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<Address, IdentityError>

Performs the conversion.

impl Eq for Address

impl StructuralPartialEq for Address