Struct RawSyncStateEventWithKeys 

pub struct RawSyncStateEventWithKeys {
    pub raw: Raw<AnySyncStateEvent>,
    pub event_type: StateEventType,
    pub state_key: String,
    /* private fields */
}

A raw sync state event and its (type, state_key) tuple that identifies it in the state map of the room.

This type can also cache the deserialized event lazily when using RawSyncStateEventWithKeys::deserialize_as().

Fields

raw: Raw<AnySyncStateEvent>

The raw state event.

event_type: StateEventType

The type of the state event.

state_key: String

The state key of the state event.

Implementations

impl RawSyncStateEventWithKeys

pub fn try_from_raw_state_event(raw: Raw<AnySyncStateEvent>) -> Option<Self>

Try to construct a RawSyncStateEventWithKeys from the given raw state event.

Returns None if extracting the type or state_key fails.

pub fn try_from_raw_timeline_event( raw: &Raw<AnySyncTimelineEvent>, ) -> Option<Self>

Try to construct a RawSyncStateEventWithKeys from the given raw timeline event.

Returns None if deserializing the type or state_key fails, or if the event is not a state event.

pub fn deserialize_as<F, C>( &mut self, as_variant_fn: F, ) -> Option<&SyncStateEvent<C>>

where F: FnOnce(&AnySyncStateEvent) -> Option<&SyncStateEvent<C>>, C: StaticEventContent + StaticStateEventContent + RedactContent, C::Redacted: RedactedStateEventContent,

Try to deserialize the raw event and return the selected variant of AnySyncStateEvent.

This method should only be called if the variant is already known. It is considered a developer error for as_variant_fn to return None, but this API was chosen to simplify closures that use the as_variant! macro.

The result of the event deserialization is cached for future calls to this method.

Returns None if the deserialization failed or if as_variant_fn returns None.

Trait Implementations

impl Clone for RawSyncStateEventWithKeys

fn clone(&self) -> RawSyncStateEventWithKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawSyncStateEventWithKeys

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

Formats the value using the given formatter.