Struct UserId 

pub struct UserId { /* private fields */ }

A unique identifier for a User within an Agent’s domain. https://gitlab.com/relay-mail/docs/-/wikis/Architecture/Identity#user-identity

Implementations

impl UserId

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

Parse a UserId from a string according to the identity rules. https://gitlab.com/relay-mail/docs/-/wikis/Architecture/Identity#user-identity

Examples

let user_id = relay_core::id::UserId::parse("Alice.Smith").unwrap();
assert_eq!(user_id.canonical(), "#alice.smith");

let user_id = relay_core::id::UserId::parse("Work#Alice.Smith").unwrap();
assert_eq!(user_id.canonical(), "work#alice.smith");

pub fn replace( &mut self, new_value: impl AsRef<str>, ) -> Result<(), IdentityError>

Replace the current UserId with a new value.

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

Get the inbox.

pub fn canonical(&self) -> String

The canonical form of the UserId. The value is already stored as such. https://gitlab.com/relay-mail/docs/-/wikis/Architecture/Identity#canonical-form

Trait Implementations

impl Clone for UserId

fn clone(&self) -> UserId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UserId

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

Formats the value using the given formatter.

impl From<Address> for UserId

fn from(address: Address) -> UserId

Converts to this type from the input type.

impl Hash for UserId

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 UserId

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

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 UserId

type Error = IdentityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for UserId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<UserId, IdentityError>

Performs the conversion.

impl TryFrom<UserId> for InboxId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(user: UserId) -> Result<InboxId, IdentityError>

Performs the conversion.

impl Eq for UserId

impl StructuralPartialEq for UserId