Struct ruma_common::events::RedactedSyncStateEvent

pub struct RedactedSyncStateEvent<C: RedactedStateEventContent> {
    pub content: C,
    pub event_id: OwnedEventId,
    pub sender: OwnedUserId,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub state_key: C::StateKey,
    pub unsigned: RedactedUnsigned,
}

A redacted state event without a room_id.

RedactedSyncStateEvent 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: RedactedUnsigned

Additional key-value pairs not signed by the homeserver.

Implementations

impl<C: RedactedStateEventContent> RedactedSyncStateEvent<C>

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

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

impl RedactedSyncStateEvent<RedactedRoomMemberEventContent>

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 membership_change<'a>(
    &'a self,
    prev_details: Option<MembershipDetails<'a>>
) -> MembershipChange<'a>

Helper function for membership change.

Since redacted events don’t have unsigned.prev_content, you have to pass the .details() of the previous m.room.member event manually (if there is a previous m.room.member event).

Check the specification for details.

Trait Implementations

impl<C: Clone + RedactedStateEventContent> Clone for RedactedSyncStateEvent<C> where
    C::StateKey: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + RedactedStateEventContent> Debug for RedactedSyncStateEvent<C> where
    C::StateKey: Debug, 

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

Formats the value using the given formatter.

impl<'de, C: RedactedStateEventContent> Deserialize<'de> for RedactedSyncStateEvent<C>

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

Deserialize this value from the given Serde deserializer.

impl<C: RedactedStateEventContent> From<RedactedStateEvent<C>> for RedactedSyncStateEvent<C>

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

Converts to this type from the input type.

impl<C: RedactedStateEventContent> Ord for RedactedSyncStateEvent<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: RedactedStateEventContent> PartialEq<RedactedSyncStateEvent<C>> for RedactedSyncStateEvent<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: RedactedStateEventContent> PartialOrd<RedactedSyncStateEvent<C>> for RedactedSyncStateEvent<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: RedactedStateEventContent> Serialize for RedactedSyncStateEvent<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: RedactedStateEventContent> Eq for RedactedSyncStateEvent<C>