Struct ruma_identifiers::event_id::EventId

pub struct EventId<T> { /* fields omitted */ }

A Matrix event ID.

An EventId is generated randomly or converted from a string slice, and can be converted back into a string as needed.

It is discouraged to use this type directly – instead use one of the aliases (EventId and EventIdRef) in the crate root.

Room versions

Matrix specifies multiple room versions and the format of event identifiers differ between them. The original format used by room versions 1 and 2 uses a short pseudorandom "localpart" followed by the hostname and port of the originating homeserver. Later room versions change event identifiers to be a hash of the event encoded with Base64. Some of the methods provided by EventId are only relevant to the original event format.

// Original format
assert_eq!(
    EventId::try_from("$h29iv0s8:example.com").unwrap().as_ref(),
    "$h29iv0s8:example.com"
);
// Room version 3 format
assert_eq!(
    EventId::try_from("$acR1l0raoZnm60CBwAVgqbZqoO/mYU81xysh1u7XcJk").unwrap().as_ref(),
    "$acR1l0raoZnm60CBwAVgqbZqoO/mYU81xysh1u7XcJk"
);
// Room version 4 format
assert_eq!(
    EventId::try_from("$Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg").unwrap().as_ref(),
    "$Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg"
);

Implementations

impl<T> EventId<T> where
    T: AsRef<str>, 

pub fn as_ref(&self) -> EventId<&str>

Creates a reference to this EventId.

pub fn localpart(&self) -> &str

Returns the event's unique ID. For the original event format as used by Matrix room versions 1 and 2, this is the "localpart" that precedes the homeserver. For later formats, this is the entire ID without the leading $ sigil.

pub fn server_name(&self) -> Option<ServerNameRef>

Returns the server name of the event ID.

Only applicable to events in the original format as used by Matrix room versions 1 and 2.

impl<T: AsRef<str>> EventId<T>

pub fn as_str(&self) -> &str

Creates a string slice from this EventId

Trait Implementations

impl<T: AsRef<str>> AsRef<str> for EventId<T>

fn as_ref(&self) -> &str

Performs the conversion.

impl<T: Clone> Clone for EventId<T>

fn clone(&self) -> EventId<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for EventId<T>

impl<T: Debug> Debug for EventId<T>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventId<Box<str>>

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

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for EventId<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for EventId<T>

impl<'a> From<&'a EventId<Box<str>>> for EventId<&'a str>

fn from(id: &'a EventId<Box<str>>) -> Self

Performs the conversion.

impl From<EventId<Box<str>>> for String

fn from(id: EventId<Box<str>>) -> Self

Performs the conversion.

impl<T: Hash> Hash for EventId<T>

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, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord> Ord for EventId<T>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_, T: AsRef<str>> PartialEq<&'_ str> for EventId<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialEq> PartialEq<EventId<T>> for EventId<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, T: AsRef<str>> PartialEq<EventId<T>> for &'_ str

fn eq(&self, other: &EventId<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: AsRef<str>> PartialEq<EventId<T>> for String

fn eq(&self, other: &EventId<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: AsRef<str>> PartialEq<String> for EventId<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<EventId<T>> for EventId<T>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: AsRef<str>> Serialize for EventId<T>

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

Serialize this value into the given Serde serializer.

impl<'_> TryFrom<&'_ str> for EventId<Box<str>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for EventId<&'a str>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for EventId<Box<str>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.