Struct ruma_events::OriginalStateEvent

pub struct OriginalStateEvent<C: StaticStateEventContent> {
    pub content: C,
    pub event_id: OwnedEventId,
    pub sender: OwnedUserId,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub room_id: OwnedRoomId,
    pub state_key: C::StateKey,
    pub unsigned: C::Unsigned,
}

An unredacted state event.

OriginalStateEvent implements the comparison traits using only the event_id field, a sorted list would be sorted lexicographically based on the event’s EventId.

Fields

content: C

Data specific to the event type.

event_id: OwnedEventId

The globally unique event identifier for the user who sent the event.

sender: OwnedUserId

The fully-qualified ID of the user who sent this event.

origin_server_ts: MilliSecondsSinceUnixEpoch

Timestamp in milliseconds on originating homeserver when this event was sent.

room_id: OwnedRoomId

The ID of the room associated with this event.

state_key: C::StateKey

A unique key which defines the overwriting semantics for this piece of room state.

This is often an empty string, but some events send a UserId to show which user the event affects.

unsigned: C::Unsigned

Additional key-value pairs not signed by the homeserver.

Implementations

impl OriginalStateEvent<RoomMemberEventContent>

pub fn details(&self) -> MembershipDetails<'_>

Obtain the details about this event that are required to calculate a membership change.

This is required when you want to calculate the change a redacted m.room.member event made.

pub fn prev_content(&self) -> Option<&RoomMemberEventContent>

Get a reference to the prev_content in unsigned, if it exists.

Shorthand for event.unsigned.prev_content.as_ref()

pub fn membership_change(&self) -> MembershipChange<'_>

Helper function for membership change.

Check the specification for details.

Trait Implementations

impl<C: Clone + StaticStateEventContent> Clone for OriginalStateEvent<C>

where C::StateKey: Clone, C::Unsigned: Clone,

fn clone(&self) -> OriginalStateEvent<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + StaticStateEventContent> Debug for OriginalStateEvent<C>

where C::StateKey: Debug, C::Unsigned: Debug,

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for OriginalStateEvent<C>

where C: EventContentFromType + StaticStateEventContent,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: StaticStateEventContent> From<OriginalStateEvent<C>> for OriginalSyncStateEvent<C>

fn from(event: OriginalStateEvent<C>) -> Self

Converts to this type from the input type.

impl<C: StaticStateEventContent> Ord for OriginalStateEvent<C>

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

Compares EventIds and orders them lexicographically.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<C: StaticStateEventContent> PartialEq for OriginalStateEvent<C>

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

Checks if two EventIds are equal.

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

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

impl<C: StaticStateEventContent> PartialOrd for OriginalStateEvent<C>

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

Compares EventIds and orders them lexicographically.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C: StaticStateEventContent> Eq for OriginalStateEvent<C>