Struct ruma_identifiers::EventId

pub struct EventId(_);

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().to_string(),
    "$h29iv0s8:example.com"
);
// Room version 3 format
assert_eq!(
    EventId::try_from("$acR1l0raoZnm60CBwAVgqbZqoO/mYU81xysh1u7XcJk").unwrap().to_string(),
    "$acR1l0raoZnm60CBwAVgqbZqoO/mYU81xysh1u7XcJk"
);
// Room version 4 format
assert_eq!(
    EventId::try_from("$Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg").unwrap().to_string(),
    "$Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg"
);

Methods

impl EventId

pub fn new(homeserver_host: &str) -> Result<Self, Error>

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.

Fails if the homeserver cannot be parsed as a valid host.

pub fn hostname(&self) -> Option<&Host>

Returns a Host for the event ID, containing the server name (minus the port) of the originating homeserver. Only applicable to events in the original format as used by Matrix room versions 1 and 2.

The host can be either a domain name, an IPv4 address, or an IPv6 address.

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 port(&self) -> Option<u16>

Returns the port the originating homeserver can be accessed on. Only applicable to events in the original format as used by Matrix room versions 1 and 2.

Trait Implementations

impl Clone for EventId

fn clone(&self) -> EventId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<EventId> for EventId

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: &EventId) -> bool

This method tests for !=.

impl Eq for EventId

impl Hash for EventId

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

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

Formats the value using the given formatter.

impl Debug for EventId

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

Formats the value using the given formatter.

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

type Error = Error

The type returned in the event of a conversion error.

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

Attempts to create a new Matrix event ID from a string representation.

If using the original event format as used by Matrix room versions 1 and 2, the string must include the leading $ sigil, the localpart, a literal colon, and a valid homeserver hostname.

impl Serialize for EventId

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

Serialize this value into the given Serde serializer.

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

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

Deserialize this value from the given Serde deserializer.