Enum ruma::events::StateEvent

source ·
pub enum StateEvent<C>{
    Original(OriginalStateEvent<C>),
    Redacted(RedactedStateEvent<<C as RedactContent>::Redacted>),
}
Available on crate feature events only.
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 as RedactContent>::Redacted>)

Redacted form of the event with minimal fields.

Implementations§

source§

impl<C> StateEvent<C>

source

pub fn event_type(&self) -> StateEventType

Available on crate feature unstable-msc3401 only.

Returns the type of this event.

source

pub fn event_id(&self) -> &EventId

Available on crate feature unstable-msc3401 only.

Returns this event’s event_id field.

source

pub fn sender(&self) -> &UserId

Available on crate feature unstable-msc3401 only.

Returns this event’s sender field.

source

pub fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

Available on crate feature unstable-msc3401 only.

Returns this event’s origin_server_ts field.

source

pub fn room_id(&self) -> &RoomId

Available on crate feature unstable-msc3401 only.

Returns this event’s room_id field.

source

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

Available on crate feature unstable-msc3401 only.

Returns this event’s state_key field.

source

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

Available on crate feature unstable-msc3401 only.

Get the inner OriginalStateEvent if this is an unredacted event.

source§

impl StateEvent<RoomGuestAccessEventContent>

source

pub fn guest_access(&self) -> &GuestAccess

Available on crate feature unstable-msc3401 only.

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

source§

impl StateEvent<RoomHistoryVisibilityEventContent>

source

pub fn history_visibility(&self) -> &HistoryVisibility

Available on crate feature unstable-msc3401 only.

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

source§

impl StateEvent<RoomJoinRulesEventContent>

source

pub fn join_rule(&self) -> &JoinRule

Available on crate feature unstable-msc3401 only.

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

source§

impl StateEvent<RoomMemberEventContent>

source

pub fn membership(&self) -> &MembershipState

Available on crate feature unstable-msc3401 only.

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

source§

impl StateEvent<RoomPowerLevelsEventContent>

source

pub fn power_levels(&self) -> RoomPowerLevels

Available on crate feature unstable-msc3401 only.

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

Trait Implementations§

source§

impl<C> Clone for StateEvent<C>

source§

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
source§

impl<C> Debug for StateEvent<C>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<StateEvent<CallMemberEventContent>> for AnyStateEvent

Available on crate feature unstable-msc3401 only.
source§

fn from(c: StateEvent<CallMemberEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<PolicyRuleRoomEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<PolicyRuleRoomEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<PolicyRuleServerEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<PolicyRuleServerEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<PolicyRuleUserEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<PolicyRuleUserEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomAliasesEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomAliasesEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomAvatarEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomAvatarEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomCanonicalAliasEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomCanonicalAliasEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomCreateEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomCreateEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomEncryptionEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomEncryptionEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomGuestAccessEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomGuestAccessEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomHistoryVisibilityEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomHistoryVisibilityEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomJoinRulesEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomJoinRulesEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomMemberEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomMemberEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomNameEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomNameEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomPinnedEventsEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomPinnedEventsEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomPowerLevelsEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomPowerLevelsEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomServerAclEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomServerAclEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomThirdPartyInviteEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomThirdPartyInviteEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomTombstoneEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomTombstoneEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<RoomTopicEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<RoomTopicEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<SpaceChildEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<SpaceChildEventContent>) -> AnyStateEvent

Converts to this type from the input type.
source§

impl From<StateEvent<SpaceParentEventContent>> for AnyStateEvent

source§

fn from(c: StateEvent<SpaceParentEventContent>) -> AnyStateEvent

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

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
source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
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
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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