Enum StateEvent

Source

pub enum StateEvent<C>where
    C: StaticStateEventContent + RedactContent,
    <C as RedactContent>::Redacted: RedactedStateEventContent,{
    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>
where C: StaticStateEventContent + RedactContent, <C as RedactContent>::Redacted: RedactedStateEventContent<StateKey = <C as StateEventContent>::StateKey> + RedactedStateEventContent,

Source

pub fn event_type(&self) -> StateEventType

Returns the type of this event.

Source

pub fn event_id(&self) -> &EventId

Returns this event’s event_id field.

Source

pub fn sender(&self) -> &UserId

Returns this event’s sender field.

Source

pub fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

Returns this event’s origin_server_ts field.

Source

pub fn room_id(&self) -> &RoomId

Returns this event’s room_id field.

Source

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

Returns this event’s state_key field.

Source

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

Get the inner OriginalStateEvent if this is an unredacted event.

Source §

impl StateEvent<RoomGuestAccessEventContent>

Source

pub fn guest_access(&self) -> &GuestAccess

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

Source §

impl StateEvent<RoomHistoryVisibilityEventContent>

Source

pub fn history_visibility(&self) -> &HistoryVisibility

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

Source §

impl StateEvent<RoomJoinRulesEventContent>

Source

pub fn join_rule(&self) -> &JoinRule

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

Source §

impl StateEvent<RoomMemberEventContent>

Source

pub fn membership(&self) -> &MembershipState

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

Source §

impl StateEvent<RoomPowerLevelsEventContent>

Source

pub fn power_levels( &self, rules: &AuthorizationRules, creators: Vec<OwnedUserId>, ) -> RoomPowerLevels

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

Trait Implementations§

Source §

impl<C> Clone for StateEvent<C>
where C: Clone + StaticStateEventContent + RedactContent, <C as RedactContent>::Redacted: RedactedStateEventContent + Clone,

Source §

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

Returns a duplicate 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>
where C: Debug + StaticStateEventContent + RedactContent, <C as RedactContent>::Redacted: RedactedStateEventContent + Debug,

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>
where C: StaticStateEventContent + EventContentFromType + RedactContent, <C as RedactContent>::Redacted: RedactedStateEventContent<StateKey = <C as StateEventContent>::StateKey> + EventContentFromType + RedactedStateEventContent,

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 §