Enum ruma::events::SyncStateEvent

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

Available on crate feature events only.

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 as RedactContent>::Redacted>)

Redacted form of the event with minimal fields.

Implementations

impl<C> SyncStateEvent<C>

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

pub fn event_type(&self) -> StateEventType

Available on crate feature unstable-msc3489 only.

Returns the type of this event.

pub fn event_id(&self) -> &EventId

Available on crate feature unstable-msc3489 only.

Returns this event’s event_id field.

pub fn sender(&self) -> &UserId

Available on crate feature unstable-msc3489 only.

Returns this event’s sender field.

pub fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

Available on crate feature unstable-msc3489 only.

Returns this event’s origin_server_ts field.

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

Available on crate feature unstable-msc3489 only.

Returns this event’s state_key field.

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

Available on crate feature unstable-msc3489 only.

Get the inner OriginalSyncStateEvent if this is an unredacted event.

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

Available on crate feature unstable-msc3489 only.

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

impl SyncStateEvent<RoomGuestAccessEventContent>

pub fn guest_access(&self) -> &GuestAccess

Available on crate feature unstable-msc3489 only.

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

impl SyncStateEvent<RoomHistoryVisibilityEventContent>

pub fn history_visibility(&self) -> &HistoryVisibility

Available on crate feature unstable-msc3489 only.

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

impl SyncStateEvent<RoomJoinRulesEventContent>

pub fn join_rule(&self) -> &JoinRule

Available on crate feature unstable-msc3489 only.

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

impl SyncStateEvent<RoomMemberEventContent>

pub fn membership(&self) -> &MembershipState

Available on crate feature unstable-msc3489 only.

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

impl SyncStateEvent<RoomPowerLevelsEventContent>

pub fn power_levels(&self) -> RoomPowerLevels

Available on crate feature unstable-msc3489 only.

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

Trait Implementations

impl<C> Clone for SyncStateEvent<C>

where C: Clone + StaticStateEventContent + RedactContent, <C as RedactContent>::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 for SyncStateEvent<C>

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

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

Formats the value using the given formatter.

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

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

fn deserialize<D>( deserializer: D, ) -> Result<SyncStateEvent<C>, <D as Deserializer<'de>>::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 as RedactContent>::Redacted: RedactedStateEventContent,

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

Converts to this type from the input type.

impl From<SyncStateEvent<BeaconInfoEventContent>> for AnySyncStateEvent

Available on crate feature unstable-msc3489 only.

fn from(c: SyncStateEvent<BeaconInfoEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<CallMemberEventContent>> for AnySyncStateEvent

Available on crate feature unstable-msc3401 only.

fn from(c: SyncStateEvent<CallMemberEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<PolicyRuleRoomEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<PolicyRuleRoomEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<PolicyRuleServerEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<PolicyRuleServerEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<PolicyRuleUserEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<PolicyRuleUserEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomAliasesEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomAliasesEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomAvatarEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomAvatarEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomCanonicalAliasEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomCanonicalAliasEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomCreateEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomCreateEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomEncryptionEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomEncryptionEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomGuestAccessEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomGuestAccessEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomHistoryVisibilityEventContent>> for AnySyncStateEvent

fn from( c: SyncStateEvent<RoomHistoryVisibilityEventContent>, ) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomJoinRulesEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomJoinRulesEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomMemberEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomMemberEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomNameEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomNameEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomPinnedEventsEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomPinnedEventsEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomPowerLevelsEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomPowerLevelsEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomServerAclEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomServerAclEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomThirdPartyInviteEventContent>> for AnySyncStateEvent

fn from( c: SyncStateEvent<RoomThirdPartyInviteEventContent>, ) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomTombstoneEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomTombstoneEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<RoomTopicEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<RoomTopicEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<SpaceChildEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<SpaceChildEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.

impl From<SyncStateEvent<SpaceParentEventContent>> for AnySyncStateEvent

fn from(c: SyncStateEvent<SpaceParentEventContent>) -> AnySyncStateEvent

Converts to this type from the input type.