Enum ruma_events::SyncStateEvent

pub enum SyncStateEvent<C: StaticStateEventContent + RedactContent>
where
    C::Redacted: RedactedStateEventContent,
{
    Original(OriginalSyncStateEvent<C>),
    Redacted(RedactedSyncStateEvent<C::Redacted>),
}

A possibly-redacted state event without a room_id.

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

Variants

Original(OriginalSyncStateEvent<C>)

Original, unredacted form of the event.

Redacted(RedactedSyncStateEvent<C::Redacted>)

Redacted form of the event with minimal fields.

Implementations

impl<C> SyncStateEvent<C>

where C: StaticStateEventContent + RedactContent, C::Redacted: RedactedStateEventContent + RedactedStateEventContent<StateKey = C::StateKey>,

pub fn event_type(&self) -> StateEventType

Returns the type of this event.

pub fn event_id(&self) -> &EventId

Returns this event’s event_id field.

pub fn sender(&self) -> &UserId

Returns this event’s sender field.

pub fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

Returns this event’s origin_server_ts field.

pub fn state_key(&self) -> &C::StateKey

Returns this event’s state_key field.

pub fn as_original(&self) -> Option<&OriginalSyncStateEvent<C>>

Get the inner OriginalSyncStateEvent if this is an unredacted event.

pub fn into_full_event(self, room_id: OwnedRoomId) -> StateEvent<C>

Convert this sync event into a full event (one with a room_id field).

impl SyncStateEvent<RoomGuestAccessEventContent>

pub fn guest_access(&self) -> &GuestAccess

Obtain the guest access policy, regardless of whether this event is redacted.

impl SyncStateEvent<RoomHistoryVisibilityEventContent>

pub fn history_visibility(&self) -> &HistoryVisibility

Obtain the history visibility, regardless of whether this event is redacted.

impl SyncStateEvent<RoomJoinRulesEventContent>

pub fn join_rule(&self) -> &JoinRule

Obtain the join rule, regardless of whether this event is redacted.

impl SyncStateEvent<RoomMemberEventContent>

pub fn membership(&self) -> &MembershipState

Obtain the membership state, regardless of whether this event is redacted.

impl SyncStateEvent<RoomPowerLevelsEventContent>

pub fn power_levels(&self) -> RoomPowerLevels

Obtain the effective power levels, regardless of whether this event is redacted.

Trait Implementations

impl<C: Clone + StaticStateEventContent + RedactContent> Clone for SyncStateEvent<C>

where C::Redacted: RedactedStateEventContent + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + StaticStateEventContent + RedactContent> Debug for SyncStateEvent<C>

where C::Redacted: RedactedStateEventContent + Debug,

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

Formats the value using the given formatter.

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

where C: StaticStateEventContent + EventContentFromType + RedactContent, C::Redacted: RedactedStateEventContent + EventContentFromType + RedactedStateEventContent<StateKey = C::StateKey>,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> From<StateEvent<C>> for SyncStateEvent<C>

where C: StaticStateEventContent + RedactContent, C::Redacted: RedactedStateEventContent,

fn from(full: StateEvent<C>) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<CallMemberEventContent>> for AnySyncStateEvent

fn from(c: SyncCallMemberEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<PolicyRuleRoomEventContent>> for AnySyncStateEvent

fn from(c: SyncPolicyRuleRoomEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<PolicyRuleServerEventContent>> for AnySyncStateEvent

fn from(c: SyncPolicyRuleServerEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<PolicyRuleUserEventContent>> for AnySyncStateEvent

fn from(c: SyncPolicyRuleUserEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomAliasesEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomAliasesEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomAvatarEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomAvatarEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomCanonicalAliasEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomCanonicalAliasEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomCreateEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomCreateEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomEncryptionEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomEncryptionEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomGuestAccessEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomGuestAccessEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomHistoryVisibilityEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomHistoryVisibilityEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomJoinRulesEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomJoinRulesEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomMemberEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomMemberEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomNameEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomNameEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomPinnedEventsEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomPinnedEventsEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomPowerLevelsEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomPowerLevelsEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomServerAclEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomServerAclEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomThirdPartyInviteEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomThirdPartyInviteEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomTombstoneEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomTombstoneEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<RoomTopicEventContent>> for AnySyncStateEvent

fn from(c: SyncRoomTopicEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<SpaceChildEventContent>> for AnySyncStateEvent

fn from(c: SyncSpaceChildEvent) -> Self

Converts to this type from the input type.

impl From<SyncStateEvent<SpaceParentEventContent>> for AnySyncStateEvent

fn from(c: SyncSpaceParentEvent) -> Self

Converts to this type from the input type.