Enum ruma_common::events::EventKind

#[non_exhaustive]
pub enum EventKind {
    GlobalAccountData,
    RoomAccountData,
    EphemeralRoomData,
    MessageLike {
        redacted: bool,
    },
    State {
        redacted: bool,
    },
    ToDevice,
    Presence,
}

Available on crate feature events only.

The “kind” of an event.

This corresponds directly to the event content marker traits.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GlobalAccountData

Global account data event kind.

RoomAccountData

Room account data event kind.

EphemeralRoomData

Ephemeral room event kind.

MessageLike

Fields

redacted: bool

Redacted variation?

Message-like event kind.

Since redacted / non-redacted message-like events are used in the same places but have different sets of fields, these two variations are treated as two closely-related event kinds.

State

Fields

redacted: bool

Redacted variation?

State event kind.

Since redacted / non-redacted state events are used in the same places but have different sets of fields, these two variations are treated as two closely-related event kinds.

ToDevice

To-device event kind.

Presence

Presence event kind.

Trait Implementations

impl Clone for EventKind

fn clone(&self) -> EventKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventKind

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

Formats the value using the given formatter.

impl Hash for EventKind

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 Ord for EventKind

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<EventKind> for EventKind

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

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

const 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<EventKind> for EventKind

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

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

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

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

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

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

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

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

const 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 Copy for EventKind

impl Eq for EventKind

impl StructuralEq for EventKind

impl StructuralPartialEq for EventKind