Struct ruma::EventId

pub struct EventId { /* 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.

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 EventId

pub fn new(server_name: &ServerName) -> EventId

Attempts to generate an EventId for the given origin server with a localpart consisting of 18 random ASCII characters. This should only be used for events in the original format as used by Matrix room versions 1 and 2.

Does not currently ever fail, but may fail in the future if the homeserver cannot be parsed parsed as a valid host.

impl 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<&ServerName>

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 EventId

pub fn as_str(&self) -> &str

Creates a string slice from this EventId

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

Creates a byte slice from this EventId

pub fn into_string(self) -> String

Converts this EventId into a String

pub fn into_bytes(self) -> Vec<u8, Global>

Converts this EventId into a Vec<u8>

Trait Implementations

impl AsRef<str> for EventId

pub fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for EventId

pub fn clone(&self) -> EventId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventId

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for EventId

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

Formats the value using the given formatter.

impl From<EventId> for Vec<u8, Global>

pub fn from(id: EventId) -> Vec<u8, Global>

Performs the conversion.

impl From<EventId> for String

pub fn from(id: EventId) -> String

Performs the conversion.

impl FromStr for EventId

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<EventId, <EventId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for EventId

pub 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, 

Feeds a slice of this type into the given Hasher.

impl Ord for EventId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ str> for EventId

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

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

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

This method tests for !=.

impl PartialEq<EventId> for EventId

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

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

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

This method tests for !=.

impl PartialEq<String> for EventId

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

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

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

This method tests for !=.

impl PartialEq<str> for EventId

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

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

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

This method tests for !=.

impl PartialOrd<EventId> for EventId

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

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

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

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

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

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

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

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

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 Serialize for EventId

pub 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 EventId

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(
    s: &str
) -> Result<EventId, <EventId as TryFrom<&'_ str>>::Error>

Performs the conversion.

impl TryFrom<String> for EventId

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(
    s: String
) -> Result<EventId, <EventId as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for EventId