Enum State

#[non_exhaustive]
pub enum State {
    Before(StateEvents),
    After(StateEvents),
}

Available on crate feature api and (crate features client-api-c or client-api-s) only.

State changes in a room.

Variants (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.

Before(StateEvents)

The state changes between the previous sync and the start of the timeline.

To get the full list of state changes since the previous sync, the state events in Timeline must be added to these events to update the local state.

With the unstable-msc4222 feature, to get this variant, use_state_after must be set to false in the Request, which is the default.

After(StateEvents)

The state changes between the previous sync and the end of the timeline.

This contains the full list of state changes since the previous sync. State events in Timeline must be ignored to update the local state.

To get this variant, use_state_after must be set to true in the Request.

Implementations

impl State

pub fn is_empty(&self) -> bool

Returns true if there are no state updates.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for State

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for State

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.