Struct InboxId 

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

A type-safe XMTP inbox id.

Backed by a [u8; 32] (v0 wire format). On the wire it is encoded as varint(version) || payload; see the module-level docs for the full wire-format contract.

Implementations

impl InboxId

pub const fn from_bytes(bytes: [u8; 32]) -> Self

Wrap a raw 32-byte inbox id.

pub const fn as_bytes(&self) -> &[u8; 32]

Borrow the raw 32-byte payload.

pub const fn into_bytes(self) -> [u8; 32]

Consume the wrapper and return the raw 32-byte payload.

pub fn from_hex(s: &str) -> Result<Self, InboxIdError>

Decode a 64-character hex inbox id string into an InboxId.

pub fn to_hex(&self) -> String

Encode the raw bytes back to their canonical 64-character hex string 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

Formats the value using the given formatter.

impl Deserialize for InboxId

fn tls_deserialize<R: Read>(bytes: &mut R) -> Result<Self, Error>

where Self: Sized,

This function deserializes the bytes from the provided a std::io::Read and returns the populated struct.

fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl Display for InboxId

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

Formats the value using the given formatter.

impl Hash for InboxId

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

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 Ord for InboxId

fn cmp(&self, other: &InboxId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for InboxId

fn partial_cmp(&self, other: &InboxId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for InboxId

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Serialize self and return it as a byte vector.

impl Size for InboxId

fn tls_serialized_len(&self) -> usize

impl Copy for InboxId

impl Eq for InboxId

impl StructuralPartialEq for InboxId