Struct KnockState

#[non_exhaustive]
pub struct KnockState {
    pub events: Vec<Raw<AnyStrippedStateEvent>>,
}

Available on crate feature api and (crate features client or server) only.

Stripped state updates of a room that the user has knocked upon.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

events: Vec<Raw<AnyStrippedStateEvent>>

The stripped state of a room that the user has knocked upon.

Implementations

impl KnockState

pub fn new() -> KnockState

Creates an empty KnockState.

pub fn is_empty(&self) -> bool

Whether there are stripped state updates in this room.

Trait Implementations

impl Clone for KnockState

fn clone(&self) -> KnockState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KnockState

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

Formats the value using the given formatter.

impl Default for KnockState

fn default() -> KnockState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KnockState

fn deserialize<__D>( __deserializer: __D, ) -> Result<KnockState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KnockState> for KnockedRoom

fn from(knock_state: KnockState) -> KnockedRoom

Converts to this type from the input type.

impl Serialize for KnockState

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.