Enum ruma_common::events::AnyStateEvent

source · [−]

#[non_exhaustive]
pub enum AnyStateEvent {
Show 21 variants
    PolicyRuleRoom(PolicyRuleRoomEvent),
    PolicyRuleServer(PolicyRuleServerEvent),
    PolicyRuleUser(PolicyRuleUserEvent),
    RoomAliases(RoomAliasesEvent),
    RoomAvatar(RoomAvatarEvent),
    RoomCanonicalAlias(RoomCanonicalAliasEvent),
    RoomCreate(RoomCreateEvent),
    RoomEncryption(RoomEncryptionEvent),
    RoomGuestAccess(RoomGuestAccessEvent),
    RoomHistoryVisibility(RoomHistoryVisibilityEvent),
    RoomJoinRules(RoomJoinRulesEvent),
    RoomMember(RoomMemberEvent),
    RoomName(RoomNameEvent),
    RoomPinnedEvents(RoomPinnedEventsEvent),
    RoomPowerLevels(RoomPowerLevelsEvent),
    RoomServerAcl(RoomServerAclEvent),
    RoomThirdPartyInvite(RoomThirdPartyInviteEvent),
    RoomTombstone(RoomTombstoneEvent),
    RoomTopic(RoomTopicEvent),
    SpaceChild(SpaceChildEvent),
    SpaceParent(SpaceParentEvent),
    // some variants omitted
}

Expand description

Any state event.

Variants (Non-exhaustive)

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

`PolicyRuleRoom(PolicyRuleRoomEvent)`

m.policy.rule.room

`PolicyRuleServer(PolicyRuleServerEvent)`

m.policy.rule.server

`PolicyRuleUser(PolicyRuleUserEvent)`

m.policy.rule.user

`RoomAliases(RoomAliasesEvent)`

m.room.aliases

`RoomAvatar(RoomAvatarEvent)`

m.room.avatar

`RoomCanonicalAlias(RoomCanonicalAliasEvent)`

m.room.canonical_alias

`RoomCreate(RoomCreateEvent)`

m.room.create

`RoomEncryption(RoomEncryptionEvent)`

m.room.encryption

`RoomGuestAccess(RoomGuestAccessEvent)`

m.room.guest_access

`RoomHistoryVisibility(RoomHistoryVisibilityEvent)`

m.room.history_visibility

`RoomJoinRules(RoomJoinRulesEvent)`

m.room.join_rules

`RoomMember(RoomMemberEvent)`

m.room.member

`RoomName(RoomNameEvent)`

m.room.name

`RoomPinnedEvents(RoomPinnedEventsEvent)`

m.room.pinned_events

`RoomPowerLevels(RoomPowerLevelsEvent)`

m.room.power_levels

`RoomServerAcl(RoomServerAclEvent)`

m.room.server_acl

`RoomThirdPartyInvite(RoomThirdPartyInviteEvent)`

m.room.third_party_invite

`RoomTombstone(RoomTombstoneEvent)`

m.room.tombstone

`RoomTopic(RoomTopicEvent)`

m.room.topic

`SpaceChild(SpaceChildEvent)`

m.space.child

`SpaceParent(SpaceParentEvent)`

m.space.parent

Implementations

impl AnyStateEvent

pub fn event_type(&self) -> StateEventType

Returns the type of this event.

pub fn original_content(&self) -> Option<AnyStateEventContent>

Returns the content for this event if it is not redacted, or None if it is.

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 event_id(&self) -> &EventId

Returns this event’s event_id field.

pub fn sender(&self) -> &UserId

Returns this event’s sender field.

pub fn state_key(&self) -> &str

Returns this event’s state_key field.

pub fn transaction_id(&self) -> Option<&TransactionId>

Returns this event’s transaction_id from inside unsigned, if there is one.

Trait Implementations

impl Clone for AnyStateEvent

fn clone(&self) -> AnyStateEvent

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 Debug for AnyStateEvent

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for AnyStateEvent

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

Deserialize this value from the given Serde deserializer. Read more

impl From<AnyStateEvent> for AnySyncStateEvent

fn from(event: AnyStateEvent) -> Self

Converts to this type from the input type.

impl From<AnyStateEvent> for AnyRoomEvent

fn from(c: AnyStateEvent) -> 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 Redact for AnyStateEvent

type Redacted = AnyStateEvent

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

Auto Trait Implementations

impl RefUnwindSafe for AnyStateEvent

impl Send for AnyStateEvent

impl Sync for AnyStateEvent

impl Unpin for AnyStateEvent

impl UnwindSafe for AnyStateEvent

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>,