Struct InboxId 

pub struct InboxId(/* private fields */);

A unique identifier for an Inbox. https://gitlab.com/relay-mail/docs/-/wikis/Architecture/Identity#inbox

Implementations

impl InboxId

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

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

Example

let inbox_id = relay_core::id::InboxId::parse("Work").unwrap();
assert_eq!(inbox_id.canonical(), "work");

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

Replace the current InboxId with a new value.

pub fn canonical(&self) -> &str

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

Trait Implementations

impl Clone for InboxId

fn clone(&self) -> InboxId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InboxId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InboxId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InboxId

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

Formats the value using the given formatter.

impl Hash for InboxId

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 InboxId

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

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 InboxId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<InboxId, 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 InboxId

type Error = IdentityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for InboxId

impl StructuralPartialEq for InboxId