Struct RedactedStateEvent 

#[non_exhaustive]
pub struct RedactedStateEvent<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::StateKey,
    pub unsigned: RedactedUnsigned,
}

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::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<C: RedactedStateEventContent> RedactedStateEvent<C>

pub fn event_type(&self) -> StateEventType

Get the event’s type.

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.

pub fn should_redact_events(&self) -> bool

Determines whether the user’s events should be redacted based on their membership.

Using MSC4293, if redact_events is true, the sender is different to the state key, and the membership is ban or leave (kick), true is returned. Otherwise, the flag should be ignored, and false is returned.

Trait Implementations

impl<C: Clone + RedactedStateEventContent> Clone for RedactedStateEvent<C>

where C::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 + RedactedStateEventContent> Debug for RedactedStateEvent<C>

where C::StateKey: Debug,

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

Formats the value using the given formatter.

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

where C: EventContentFromType + RedactedStateEventContent,

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

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

Compares the EventIds of the events 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: RedactedStateEventContent> PartialEq for RedactedStateEvent<C>

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

Checks if the EventIds of the events 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: RedactedStateEventContent> PartialOrd for RedactedStateEvent<C>

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

Compares the EventIds of the events 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: RedactedStateEventContent> Eq for RedactedStateEvent<C>

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

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

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

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

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

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

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

impl<C: StaticStateEventContent + RedactContent> JsonCastable<StateEvent<C>> for RedactedStateEvent<C::Redacted>

where C::Redacted: RedactedStateEventContent,

impl<C: StaticStateEventContent + RedactContent> JsonCastable<SyncStateEvent<C>> for RedactedStateEvent<C::Redacted>

where C::Redacted: RedactedStateEventContent,