Struct ruma_common::events::OriginalSyncStateEvent

pub struct OriginalSyncStateEvent<C: StateEventContent> {
    pub content: C,
    pub event_id: OwnedEventId,
    pub sender: OwnedUserId,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub state_key: C::StateKey,
    pub unsigned: StateUnsigned<C>,
}

An unredacted state event without a room_id.

OriginalSyncStateEvent 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.

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: StateUnsigned<C>

Additional key-value pairs not signed by the homeserver.

Implementations

impl<C: StateEventContent> OriginalSyncStateEvent<C>

pub fn into_full_event(self, room_id: OwnedRoomId) -> OriginalStateEvent<C>

Convert this sync event into a full event, one with a room_id field.

impl OriginalSyncStateEvent<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 + StateEventContent> Clone for OriginalSyncStateEvent<C> where
    C::StateKey: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + StateEventContent> Debug for OriginalSyncStateEvent<C> where
    C::StateKey: Debug, 

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

Formats the value using the given formatter.

impl<'de, C: StateEventContent> Deserialize<'de> for OriginalSyncStateEvent<C>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Converts to this type from the input type.

impl<C: StateEventContent> Ord for OriginalSyncStateEvent<C>

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

Compares EventIds and orders them lexicographically.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<C: StateEventContent> PartialEq<OriginalSyncStateEvent<C>> for OriginalSyncStateEvent<C>

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

Checks if two EventIds are equal.

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

This method tests for !=.

impl<C: StateEventContent> PartialOrd<OriginalSyncStateEvent<C>> for OriginalSyncStateEvent<C>

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

Compares EventIds and orders them lexicographically.

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<C: StateEventContent> Redact for OriginalSyncStateEvent<C> where
    C: RedactContent,
    <C as RedactContent>::Redacted: StateEventContent<StateKey = C::StateKey> + RedactedEventContent, 

type Redacted = RedactedSyncStateEvent<<C as RedactContent>::Redacted>

The redacted form of the event.

fn redact(
    self,
    redaction: SyncRoomRedactionEvent,
    version: &RoomVersionId
) -> Self::Redacted

Transforms self into a redacted form (removing most fields) according to the spec.

impl<C: StateEventContent> Serialize for OriginalSyncStateEvent<C>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<C: StateEventContent> Eq for OriginalSyncStateEvent<C>