Struct ruma::EventId

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

Implementations

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.

impl EventId

pub fn parse(s: impl AsRef<str>) -> Result<OwnedEventId, Error>

Try parsing a &str into an OwnedEventId.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_box( s: impl AsRef<str> + Into<Box<str, Global>> ) -> Result<Box<EventId, Global>, Error>

Try parsing a &str into a Box<EventId>.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_rc( s: impl AsRef<str> + Into<Rc<str>> ) -> Result<Rc<EventId>, Error>

Try parsing a &str into an Rc<EventId>.

pub fn parse_arc( s: impl AsRef<str> + Into<Arc<str>> ) -> Result<Arc<EventId>, Error>

Try parsing a &str into an Arc<EventId>.

impl EventId

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

Available on crate feature rand only.

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.

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.

Trait Implementations

impl AsRef<[u8]> for EventId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<EventId> for OwnedEventId

fn as_ref(&self) -> &EventId

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for EventId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<EventId> for OwnedEventId

fn borrow(&self) -> &EventId

Immutably borrows from an owned value.

impl Clone for Box<EventId, Global>

fn clone(&self) -> Box<EventId, Global>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Box<EventId, Global>

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

Deserialize this value from the given Serde deserializer.

impl Display for EventId

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

Formats the value using the given formatter.

impl From<&EventId> for Arc<EventId>

fn from(s: &EventId) -> Arc<EventId>

Converts to this type from the input type.

impl From<&EventId> for Box<EventId, Global>

fn from(id: &EventId) -> Box<EventId, Global>

Converts to this type from the input type.

impl From<&EventId> for OwnedEventId

fn from(id: &EventId) -> OwnedEventId

Converts to this type from the input type.

impl From<&EventId> for Rc<EventId>

fn from(s: &EventId) -> Rc<EventId>

Converts to this type from the input type.

impl From<&EventId> for String

fn from(id: &EventId) -> String

Converts to this type from the input type.

impl From<OwnedEventId> for Box<EventId, Global>

fn from(a: OwnedEventId) -> Box<EventId, Global>

Converts to this type from the input type.

impl Hash for EventId

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

Feeds this value into the given Hasher.

impl Ord for EventId

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

This method returns an Ordering between self and other.

impl PartialEq<&EventId> for OwnedEventId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for EventId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Box<EventId, Global>> for &EventId

fn eq(&self, other: &Box<EventId, Global>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Box<EventId, Global>> for EventId

fn eq(&self, other: &Box<EventId, Global>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<EventId> for &str

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<EventId> for OwnedEventId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<EventId> for str

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedEventId> for &EventId

fn eq(&self, other: &OwnedEventId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<OwnedEventId> for EventId

fn eq(&self, other: &OwnedEventId) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for EventId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for EventId

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<EventId> for EventId

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

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

type Owned = OwnedEventId

The resulting type after obtaining ownership.

fn to_owned(&self) -> <EventId as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for Box<EventId, Global>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( s: &str ) -> Result<Box<EventId, Global>, <Box<EventId, Global> as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for Box<EventId, Global>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for EventId

impl StructuralEq for EventId

impl StructuralPartialEq for EventId