Enum ruma_common::events::StateEvent

source · [−]

pub enum StateEvent<C: StateEventContent + RedactContent> where
    C::Redacted: StateEventContent + RedactedEventContent,  {
    Original(OriginalStateEvent<C>),
    Redacted(RedactedStateEvent<C::Redacted>),
}

Expand description

A possibly-redacted state event.

StateEvent 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(OriginalStateEvent<C>)`

Original, unredacted form of the event.

`Redacted(RedactedStateEvent<C::Redacted>)`

Redacted form of the event with minimal fields.

Implementations

impl<C> StateEvent<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 room_id(&self) -> &RoomId

Returns this event’s room_id field.

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

Returns this event’s state_key field.

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

Get the inner OriginalStateEvent if this is an unredacted event.

impl StateEvent<RoomGuestAccessEventContent>

pub fn guest_access(&self) -> &GuestAccess

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

impl StateEvent<RoomHistoryVisibilityEventContent>

pub fn history_visibility(&self) -> &HistoryVisibility

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

impl StateEvent<RoomJoinRulesEventContent>

pub fn join_rule(&self) -> &JoinRule

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

impl StateEvent<RoomMemberEventContent>

pub fn membership(&self) -> &MembershipState

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

impl StateEvent<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 StateEvent<C> where
C::Redacted: StateEventContent + RedactedEventContent,
C::Redacted: Clone,

fn clone(&self) -> StateEvent<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 StateEvent<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 StateEvent<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<StateEvent<PolicyRuleRoomEventContent>> for AnyStateEvent

fn from(c: PolicyRuleRoomEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<PolicyRuleServerEventContent>> for AnyStateEvent

fn from(c: PolicyRuleServerEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<PolicyRuleUserEventContent>> for AnyStateEvent

fn from(c: PolicyRuleUserEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomAliasesEventContent>> for AnyStateEvent

fn from(c: RoomAliasesEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomAvatarEventContent>> for AnyStateEvent

fn from(c: RoomAvatarEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomCanonicalAliasEventContent>> for AnyStateEvent

fn from(c: RoomCanonicalAliasEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomCreateEventContent>> for AnyStateEvent

fn from(c: RoomCreateEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomEncryptionEventContent>> for AnyStateEvent

fn from(c: RoomEncryptionEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomGuestAccessEventContent>> for AnyStateEvent

fn from(c: RoomGuestAccessEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomHistoryVisibilityEventContent>> for AnyStateEvent

fn from(c: RoomHistoryVisibilityEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomJoinRulesEventContent>> for AnyStateEvent

fn from(c: RoomJoinRulesEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomMemberEventContent>> for AnyStateEvent

fn from(c: RoomMemberEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomNameEventContent>> for AnyStateEvent

fn from(c: RoomNameEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomPinnedEventsEventContent>> for AnyStateEvent

fn from(c: RoomPinnedEventsEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomPowerLevelsEventContent>> for AnyStateEvent

fn from(c: RoomPowerLevelsEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomServerAclEventContent>> for AnyStateEvent

fn from(c: RoomServerAclEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomThirdPartyInviteEventContent>> for AnyStateEvent

fn from(c: RoomThirdPartyInviteEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomTombstoneEventContent>> for AnyStateEvent

fn from(c: RoomTombstoneEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<RoomTopicEventContent>> for AnyStateEvent

fn from(c: RoomTopicEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<SpaceChildEventContent>> for AnyStateEvent

fn from(c: SpaceChildEvent) -> Self

Converts to this type from the input type.

impl From<StateEvent<SpaceParentEventContent>> for AnyStateEvent

fn from(c: SpaceParentEvent) -> Self

Converts to this type from the input type.

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

type Redacted = StateEvent<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 StateEvent<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 StateEvent<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 StateEvent<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 StateEvent<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 StateEvent<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 StateEvent<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>,