Struct StrippedStateEvent

pub struct StrippedStateEvent<C: PossiblyRedactedStateEventContent> {
    pub content: C,
    pub sender: OwnedUserId,
    pub state_key: C::StateKey,
    pub event_id: Option<OwnedEventId>,
    pub origin_server_ts: Option<MilliSecondsSinceUnixEpoch>,
}

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

Fields

content: C

Data specific to the event type.

sender: OwnedUserId

The fully-qualified ID of the user who sent 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.

event_id: Option<OwnedEventId>

The globally unique identifier for the event.

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

origin_server_ts: Option<MilliSecondsSinceUnixEpoch>

Timestamp on the originating homeserver when this event was sent.

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

Implementations

impl StrippedStateEvent<RoomMemberEventContent>

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 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.

impl StrippedStateEvent<RoomPowerLevelsEventContent>

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

Obtain the effective power levels from this event.

Trait Implementations

impl<C: Clone + PossiblyRedactedStateEventContent> Clone for StrippedStateEvent<C>

where C::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 + PossiblyRedactedStateEventContent> Debug for StrippedStateEvent<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 StrippedStateEvent<C>

where C: EventContentFromType + PossiblyRedactedStateEventContent,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StrippedStateEvent<CallMemberEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedCallMemberEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedBeaconInfoEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedBeaconInfoEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedMemberHintsEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedMemberHintsEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedPolicyRuleRoomEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedPolicyRuleRoomEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedPolicyRuleServerEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedPolicyRuleServerEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedPolicyRuleUserEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedPolicyRuleUserEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomAliasesEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomAliasesEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomEncryptionEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomEncryptionEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomGuestAccessEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomGuestAccessEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomImagePackEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomImagePackEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomNameEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomNameEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomPinnedEventsEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomPinnedEventsEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomTombstoneEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomTombstoneEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedRoomTopicEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomTopicEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedSpaceChildEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedSpaceChildEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedSpaceParentEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedSpaceParentEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PossiblyRedactedStateRoomEncryptedEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedStateRoomEncryptedEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomAvatarEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomAvatarEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomCanonicalAliasEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomCanonicalAliasEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomCreateEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomCreateEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomHistoryVisibilityEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomHistoryVisibilityEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomJoinRulesEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomJoinRulesEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomMemberEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomMemberEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomPowerLevelsEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomPowerLevelsEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomServerAclEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomServerAclEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomThirdPartyInviteEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomThirdPartyInviteEvent) -> Self

Converts to this type from the input type.

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

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

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

where C::PossiblyRedacted: PossiblyRedactedStateEventContent,

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

where C::PossiblyRedacted: PossiblyRedactedStateEventContent,

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

where C::Redacted: RedactedStateEventContent, C::PossiblyRedacted: PossiblyRedactedStateEventContent,

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

where C::Redacted: RedactedStateEventContent, C::PossiblyRedacted: PossiblyRedactedStateEventContent,