Struct StrippedStateEvent 

#[non_exhaustive]
pub struct StrippedStateEvent<C>
where
    C: PossiblyRedactedStateEventContent,
{
    pub content: C,
    pub sender: OwnedUserId,
    pub state_key: <C as PossiblyRedactedStateEventContent>::StateKey,
    pub origin_server_ts: Option<MilliSecondsSinceUnixEpoch>,
    pub unsigned: Option<Raw<StateUnsigned<C>>>,
}

Available on crate feature events only.

A stripped-down state event, used for previews of rooms the user has been invited to.

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.

sender: OwnedUserId

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

state_key: <C as PossiblyRedactedStateEventContent>::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.

origin_server_ts: Option<MilliSecondsSinceUnixEpoch>

Available on crate feature unstable-msc4319 only.

Timestamp on the originating homeserver when this event was sent.

This field is usually stripped, but some events might include it.

unsigned: Option<Raw<StateUnsigned<C>>>

Available on crate feature unstable-msc4319 only.

Additional key-value pairs not signed by the homeserver.

Implementations

impl<C> StrippedStateEvent<C>

where C: PossiblyRedactedStateEventContent,

pub fn event_type(&self) -> StateEventType

Available on crate feature unstable-msc3489 only.

Get the event’s type.

impl StrippedStateEvent<PossiblyRedactedRoomMemberEventContent>

pub fn details(&self) -> MembershipDetails<'_>

Available on crate feature unstable-msc3489 only.

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>

Available on crate feature unstable-msc3489 only.

Helper function for membership change.

Since stripped 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

Available on crate features unstable-msc3489 and unstable-msc4293 only.

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.

impl StrippedStateEvent<RoomPowerLevelsEventContent>

pub fn power_levels( &self, rules: &AuthorizationRules, creators: Vec<OwnedUserId>, ) -> RoomPowerLevels

Available on crate feature unstable-msc3489 only.

Obtain the effective power levels from this event.

Trait Implementations

impl<C> Clone for StrippedStateEvent<C>

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for StrippedStateEvent<C>

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

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

Formats the value using the given formatter.

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

where C: PossiblyRedactedStateEventContent + EventContentFromType,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StrippedStateEvent<CallMemberEventContent>> for AnyStrippedStateEvent

Available on crate feature unstable-msc3401 only.

fn from(c: StrippedStateEvent<CallMemberEventContent>) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedBeaconInfoEventContent>> for AnyStrippedStateEvent

Available on crate feature unstable-msc3489 only.

fn from( c: StrippedStateEvent<PossiblyRedactedBeaconInfoEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedMemberHintsEventContent>> for AnyStrippedStateEvent

Available on crate feature unstable-msc4171 only.

fn from( c: StrippedStateEvent<PossiblyRedactedMemberHintsEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedPolicyRuleRoomEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedPolicyRuleRoomEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedPolicyRuleServerEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedPolicyRuleServerEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedPolicyRuleUserEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedPolicyRuleUserEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomEncryptionEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomEncryptionEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomGuestAccessEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomGuestAccessEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomImagePackEventContent>> for AnyStrippedStateEvent

Available on crate feature unstable-msc2545 only.

fn from( c: StrippedStateEvent<PossiblyRedactedRoomImagePackEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomLanguageEventContent>> for AnyStrippedStateEvent

Available on crate feature unstable-msc4334 only.

fn from( c: StrippedStateEvent<PossiblyRedactedRoomLanguageEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomMemberEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomMemberEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomNameEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomNameEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomPinnedEventsEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomPinnedEventsEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomPolicyEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomPolicyEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomTombstoneEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomTombstoneEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomTopicEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedRoomTopicEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedSpaceChildEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedSpaceChildEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedSpaceParentEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<PossiblyRedactedSpaceParentEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedStateRoomEncryptedEventContent>> for AnyStrippedStateEvent

Available on crate feature unstable-msc4362 only.

fn from( c: StrippedStateEvent<PossiblyRedactedStateRoomEncryptedEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomAvatarEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedStateEvent<RoomAvatarEventContent>) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomCanonicalAliasEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<RoomCanonicalAliasEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomCreateEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedStateEvent<RoomCreateEventContent>) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomHistoryVisibilityEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<RoomHistoryVisibilityEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomJoinRulesEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<RoomJoinRulesEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomPowerLevelsEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<RoomPowerLevelsEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomServerAclEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<RoomServerAclEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomThirdPartyInviteEventContent>> for AnyStrippedStateEvent

fn from( c: StrippedStateEvent<RoomThirdPartyInviteEventContent>, ) -> AnyStrippedStateEvent

Converts to this type from the input type.

impl<C> JsonCastable<AnyStrippedStateEvent> for StrippedStateEvent<C>

where C: PossiblyRedactedStateEventContent,

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

where C: PossiblyRedactedStateEventContent,

impl<C> JsonCastable<StrippedStateEvent<<C as StaticStateEventContent>::PossiblyRedacted>> for OriginalStateEvent<C>

where C: StaticStateEventContent, <C as StaticStateEventContent>::PossiblyRedacted: PossiblyRedactedStateEventContent,

impl<C> JsonCastable<StrippedStateEvent<<C as StaticStateEventContent>::PossiblyRedacted>> for OriginalSyncStateEvent<C>

where C: StaticStateEventContent, <C as StaticStateEventContent>::PossiblyRedacted: PossiblyRedactedStateEventContent,

impl<C> JsonCastable<StrippedStateEvent<<C as StaticStateEventContent>::PossiblyRedacted>> for StateEvent<C>

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

impl<C> JsonCastable<StrippedStateEvent<<C as StaticStateEventContent>::PossiblyRedacted>> for SyncStateEvent<C>

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