Struct RedactedStateEvent 

#[non_exhaustive]
pub struct RedactedStateEvent<C>
where
    C: RedactedStateEventContent,
{
    pub content: C,
    pub event_id: OwnedEventId,
    pub sender: OwnedUserId,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub room_id: OwnedRoomId,
    pub state_key: <C as RedactedStateEventContent>::StateKey,
    pub unsigned: RedactedUnsigned,
}

Available on crate feature events only.

A redacted state event.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: C

Data specific to the event type.

event_id: OwnedEventId

The globally unique identifier for the event.

sender: OwnedUserId

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

origin_server_ts: MilliSecondsSinceUnixEpoch

Timestamp on the originating homeserver when this event was sent.

room_id: OwnedRoomId

The ID of the room associated with this event.

state_key: <C as RedactedStateEventContent>::StateKey

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

This must be a string type, and is often an empty string.

A state event is keyed by its (type, state_key) tuple. Sending another state event with the same tuple replaces the previous one.

unsigned: RedactedUnsigned

Additional key-value pairs not signed by the homeserver.

Implementations

impl RedactedStateEvent<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 for RedactedStateEvent<C>

where C: Clone + RedactedStateEventContent, <C as RedactedStateEventContent>::StateKey: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for RedactedStateEvent<C>

where C: Debug + RedactedStateEventContent, <C as RedactedStateEventContent>::StateKey: Debug,

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

Formats the value using the given formatter.

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

where C: RedactedStateEventContent + EventContentFromType,

fn deserialize<D>( deserializer: D, ) -> Result<RedactedStateEvent<C>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where C: RedactedStateEventContent,

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

Converts to this type from the input type.

impl<C> Ord for RedactedStateEvent<C>

where C: RedactedStateEventContent,

fn cmp(&self, other: &RedactedStateEvent<C>) -> 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,

Restrict a value to a certain interval.

impl<C> PartialEq for RedactedStateEvent<C>

where C: RedactedStateEventContent,

fn eq(&self, other: &RedactedStateEvent<C>) -> 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> PartialOrd for RedactedStateEvent<C>

where C: RedactedStateEventContent,

fn partial_cmp(&self, other: &RedactedStateEvent<C>) -> 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 SpaceChildOrd for RedactedStateEvent<RedactedSpaceChildEventContent>

fn cmp_space_child(&self, other: &impl SpaceChildOrd) -> Ordering

Return an Ordering between self and other, using the algorithm for ordering children within a space.

impl<C> Eq for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<AnyStateEvent> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<AnyStrippedStateEvent> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<AnySyncStateEvent> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<AnySyncTimelineEvent> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<AnyTimelineEvent> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<Map<String, Value>> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<RedactedSyncStateEvent<C>> for RedactedStateEvent<C>

where C: RedactedStateEventContent,

impl<C> JsonCastable<StateEvent<C>> for RedactedStateEvent<<C as RedactContent>::Redacted>

where C: StaticStateEventContent + RedactContent, <C as RedactContent>::Redacted: RedactedStateEventContent,

impl<C> JsonCastable<SyncStateEvent<C>> for RedactedStateEvent<<C as RedactContent>::Redacted>

where C: StaticStateEventContent + RedactContent, <C as RedactContent>::Redacted: RedactedStateEventContent,