Struct RoomState

#[non_exhaustive]
pub struct RoomState {
    pub members_omitted: bool,
    pub auth_chain: Vec<Box<RawValue>>,
    pub state: Vec<Box<RawValue>>,
    pub event: Option<Box<RawValue>>,
    pub servers_in_room: Option<Vec<String>>,
}

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

Full state of the room.

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.

members_omitted: bool

Whether m.room.member events have been omitted from state.

Defaults to false.

auth_chain: Vec<Box<RawValue>>

The full set of authorization events that make up the state of the room, and their authorization events, recursively.

If the request had omit_members set to true, then any events that are returned in state may be omitted from auth_chain, whether or not membership events are omitted from state.

state: Vec<Box<RawValue>>

The room state.

If the request had omit_members set to true, events of type m.room.member may be omitted from the response to reduce the size of the response. If this is done, members_omitted must be set to true.

event: Option<Box<RawValue>>

The signed copy of the membership event sent to other servers by the resident server, including the resident server’s signature.

Required if the room version supports restricted join rules.

servers_in_room: Option<Vec<String>>

A list of the servers active in the room (ie, those with joined members) before the join.

Required if members_omitted is set to true.

Implementations

impl RoomState

pub fn new() -> RoomState

Available on crate feature unstable-unspecified only.

Creates an empty RoomState with the given origin.

Without the unstable-unspecified feature, this method takes a parameter for the origin. See matrix-spec#374.

Trait Implementations

impl Clone for RoomState

fn clone(&self) -> RoomState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomState

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

Formats the value using the given formatter.

impl Default for RoomState

Available on crate feature unstable-unspecified only.

fn default() -> RoomState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RoomState

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.