Enum ruma_common::events::SyncStateEvent

source · [−]

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

Expand description

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

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl<'de, C> Deserialize<'de> for SyncStateEvent<C> where
    C: StateEventContent + RedactContent,
    C::Redacted: StateEventContent + RedactedEventContent,
    C::Redacted: StateEventContent<StateKey = C::StateKey>,

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

Deserialize this value from the given Serde deserializer. Read more

impl<C> From<StateEvent<C>> for SyncStateEvent<C> where
C: StateEventContent + RedactContent,
C::Redacted: StateEventContent + RedactedEventContent,

fn from(full: StateEvent<C>) -> 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.

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

type Redacted = SyncStateEvent<C>

The redacted form of the event.

fn redact(
    self,
    redaction: SyncRoomRedactionEvent,
    version: &RoomVersionId
) -> Self

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

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

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl<C> RefUnwindSafe for SyncStateEvent<C> where
    C: RefUnwindSafe,
    <C as RedactContent>::Redacted: RefUnwindSafe,
    <C as StateEventContent>::StateKey: RefUnwindSafe,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey: RefUnwindSafe,

impl<C> Send for SyncStateEvent<C> where
    C: Send,
    <C as RedactContent>::Redacted: Send,
    <C as StateEventContent>::StateKey: Send,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey: Send,

impl<C> Sync for SyncStateEvent<C> where
    C: Sync,
    <C as RedactContent>::Redacted: Sync,
    <C as StateEventContent>::StateKey: Sync,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey: Sync,

impl<C> Unpin for SyncStateEvent<C> where
    C: Unpin,
    <C as RedactContent>::Redacted: Unpin,
    <C as StateEventContent>::StateKey: Unpin,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey: Unpin,

impl<C> UnwindSafe for SyncStateEvent<C> where
    C: UnwindSafe,
    <C as RedactContent>::Redacted: UnwindSafe,
    <C as StateEventContent>::StateKey: UnwindSafe,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,