Struct ruma_identifiers::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.

assert_eq!(
    EventId::try_from("$h29iv0s8:example.com").unwrap().to_string(),
    "$h29iv0s8:example.com"
);

Methods

impl EventId

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

Attempts to generate an EventId for the given origin server with a localpart consisting of 18 random ASCII characters.

Fails if the given origin server name cannot be parsed as a valid host.

pub fn hostname(&self) -> &Host

Returns a Host for the event ID, containing the server name (minus the port) of the originating homeserver.

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

pub fn opaque_id(&self) -> &str

Returns the event's opaque ID.

pub fn port(&self) -> u16

Returns the port the originating homeserver can be accessed on.

Trait Implementations

impl Eq for EventId

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

fn clone(&self) -> EventId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventId

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

Formats the value using the given formatter.

impl Hash for EventId

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

Feeds this value into the given [Hasher].

default 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<'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.

The string must include the leading $ sigil, the opaque ID, a literal colon, and a valid server name.

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.