Struct ruma_events::SyncStateEvent

pub struct SyncStateEvent<C: StateEventContent> {
    pub content: C,
    pub event_id: EventId,
    pub sender: UserId,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub state_key: String,
    pub prev_content: Option<C>,
    pub unsigned: Unsigned,
}

A state event without a room_id.

SyncStateEvent 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: EventId

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

sender: UserId

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: String

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.

prev_content: Option<C>

Optional previous content for this event.

unsigned: Unsigned

Additional key-value pairs not signed by the homeserver.

Implementations

impl<C: StateEventContent> SyncStateEvent<C>

pub fn into_full_event(self, room_id: RoomId) -> StateEvent<C>

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

impl SyncStateEvent<MemberEventContent>

pub fn membership_change(&self) -> MembershipChange

Helper function for membership change. Check the specification for details.

Trait Implementations

impl<C: Clone + StateEventContent> Clone for SyncStateEvent<C>

fn clone(&self) -> SyncStateEvent<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 SyncStateEvent<C>

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

Formats the value using the given formatter.

impl<'de, C: StateEventContent> Deserialize<'de> for SyncStateEvent<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<StateEvent<C>> for SyncStateEvent<C>

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

Performs the conversion.

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

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

This 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<SyncStateEvent<C>> for SyncStateEvent<C>

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

This checks if two EventIds are equal.

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

This method tests for !=.

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

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

This 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> Serialize for SyncStateEvent<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 SyncStateEvent<C>