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.

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"
);

Methods

impl EventId

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

This is supported on 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.

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

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<&str>

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<'expr> AsExpression<Nullable<Text>> for &'expr EventId

type Expression = Bound<Nullable<Text>, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Nullable<Text>> for EventId

type Expression = Bound<Nullable<Text>, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<'expr> AsExpression<Text> for &'expr EventId

type Expression = Bound<Text, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Text> for EventId

type Expression = Bound<Text, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsRef<str> for EventId

fn as_ref(&self) -> &str

Performs the conversion.

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

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

Formats the value using the given formatter.

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.

impl Display for EventId

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

Formats the value using the given formatter.

impl Eq for EventId

impl From<EventId> for String

fn from(id: EventId) -> Self

Performs the conversion.

impl<DB> FromSql<Text, DB> for EventId where
    String: FromSql<Text, DB>,
    DB: Backend, 

fn from_sql(
    value: Option<&<DB as Backend>::RawValue>
) -> DeserializeResult<Self>

See the trait documentation.

impl<__ST, __DB> FromSqlRow<__ST, __DB> for EventId where
    __DB: Backend,
    Self: FromSql<__ST, __DB>, 

fn build_from_row<R: Row<__DB>>(row: &mut R) -> Result<Self>

See the trait documentation.

const FIELDS_NEEDED: usize

The number of fields that this type will consume. Must be equal to the number of times you would call row.take() in build_from_row

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

impl Ord for EventId

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<'_> 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 ==.

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

This method tests for !=.

impl PartialEq<EventId> for EventId

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<'_> 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 ==.

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

This method tests for !=.

impl PartialEq<EventId> for String

fn eq(&self, other: &EventId) -> 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 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 ==.

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

This method tests for !=.

impl PartialOrd<EventId> for EventId

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

type QueryId = EventId

A type which uniquely represents Self in a SQL query.

const HAS_STATIC_QUERY_ID: bool

Can the SQL generated by Self be uniquely identified by its type?

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl<__ST, __DB> Queryable<__ST, __DB> for EventId where
    __DB: Backend,
    Self: FromSql<__ST, __DB>, 

type Row = Self

The Rust type you'd like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

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

impl<__DB> ToSql<Nullable<Text>, __DB> for EventId where
    __DB: Backend,
    Self: ToSql<Text, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

See the trait documentation.

impl<DB> ToSql<Text, DB> for EventId where
    DB: Backend, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> SerializeResult

See the trait documentation.

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

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<'_> TryFrom<Cow<'_, str>> for EventId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(event_id: Cow<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 TryFrom<String> for EventId

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.