Struct ruma_common::events::StrippedStateEvent

pub struct StrippedStateEvent<C: StateEventContent> {
    pub content: C,
    pub sender: OwnedUserId,
    pub state_key: C::StateKey,
}

Available on crate feature events only.

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 is often an empty string, but some events send a UserId to show which user the event affects.

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) -> RoomPowerLevels

Obtain the effective power levels from this event.

Trait Implementations

impl<C: Clone + StateEventContent> Clone for StrippedStateEvent<C>where
    C::StateKey: Clone,

fn clone(&self) -> StrippedStateEvent<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 StrippedStateEvent<C>where
    C::StateKey: Debug,

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StrippedStateEvent<PolicyRuleRoomEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedPolicyRuleRoomEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PolicyRuleServerEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedPolicyRuleServerEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<PolicyRuleUserEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedPolicyRuleUserEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomAliasesEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomAliasesEvent) -> 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<RoomEncryptionEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomEncryptionEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomGuestAccessEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomGuestAccessEvent) -> 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<RoomNameEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomNameEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomPinnedEventsEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomPinnedEventsEvent) -> 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 From<StrippedStateEvent<RoomTombstoneEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomTombstoneEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<RoomTopicEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedRoomTopicEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<SpaceChildEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedSpaceChildEvent) -> Self

Converts to this type from the input type.

impl From<StrippedStateEvent<SpaceParentEventContent>> for AnyStrippedStateEvent

fn from(c: StrippedSpaceParentEvent) -> Self

Converts to this type from the input type.

impl<C: StateEventContent> Serialize for StrippedStateEvent<C>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.