Enum ruma::events::StateEvent

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

Available on crate feature events only.

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

impl<C> StateEvent<C>where
    C: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: RedactedStateEventContent,
    <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 room_id(&self) -> &RoomId

Returns this event’s room_id field.

pub fn state_key(&self) -> &<C as StateEventContent>::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 for StateEvent<C>where
    C: Clone + StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: RedactedStateEventContent,
    <C as RedactContent>::Redacted: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for StateEvent<C>where
    C: Debug + StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: RedactedStateEventContent,
    <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 StateEvent<C>where
    C: StateEventContent + RedactContent,
    <C as RedactContent>::Redacted: RedactedStateEventContent,
    <C as RedactContent>::Redacted: StateEventContent,
    <<C as RedactContent>::Redacted as StateEventContent>::StateKey == <C as StateEventContent>::StateKey,

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.

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

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

Converts to this type from the input type.

impl From<StateEvent<PolicyRuleRoomEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<PolicyRuleServerEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<PolicyRuleUserEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomAliasesEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomAvatarEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomCanonicalAliasEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomCreateEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomEncryptionEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomGuestAccessEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomHistoryVisibilityEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomJoinRulesEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomMemberEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomNameEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomPinnedEventsEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomPowerLevelsEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomServerAclEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomThirdPartyInviteEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomTombstoneEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<RoomTopicEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<SpaceChildEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

impl From<StateEvent<SpaceParentEventContent>> for AnyStateEvent

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

Converts to this type from the input type.

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

type Redacted = StateEvent<C>

The redacted form of the event.

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

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

impl<C> Serialize for StateEvent<C>where
    C: StateEventContent + RedactContent + Serialize,
    <C as RedactContent>::Redacted: RedactedStateEventContent,

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.