Enum ruma::events::SyncStateEvent

pub enum SyncStateEvent<C> where
    C: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent,  {
    Original(OriginalSyncStateEvent<C>),
    Redacted(RedactedSyncStateEvent<<C as RedactContent>::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 as RedactContent>::Redacted>)

Redacted form of the event with minimal fields.

Implementations

impl<C> SyncStateEvent<C> where
    C: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey == <C as StateEventContent>::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 as StateEventContent>::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 for SyncStateEvent<C> where
    C: Clone + StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent,
    <C as RedactContent>::Redacted: 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 + StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent,
    <C as RedactContent>::Redacted: 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: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey == <C as StateEventContent>::StateKey, 

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: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent, 

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

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.

impl<C> Redact for SyncStateEvent<C> where
    C: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey == <C as StateEventContent>::StateKey, 

type Redacted = SyncStateEvent<C>

The redacted form of the event.

fn redact(
    self,
    redaction: SyncRoomRedactionEvent,
    version: &RoomVersionId
) -> SyncStateEvent<C>

Transforms self into a redacted form (removing most fields) according to the spec.

impl<C> Serialize for SyncStateEvent<C> where
    C: StateEventContent + RedactContent + Serialize,
    <C as RedactContent>::Redacted: StateEventContent,
    <C as RedactContent>::Redacted: RedactedEventContent, 

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.