Struct RoomSummary

#[non_exhaustive]
pub struct RoomSummary {
    pub heroes: Vec<OwnedUserId>,
    pub joined_member_count: Option<UInt>,
    pub invited_member_count: Option<UInt>,
}

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

Information about room for rendering to clients.

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.

heroes: Vec<OwnedUserId>

Users which can be used to generate a room name if the room does not have one.

Required if room name or canonical aliases are not set or empty.

joined_member_count: Option<UInt>

Number of users whose membership status is join. Required if field has changed since last sync; otherwise, it may be omitted.

invited_member_count: Option<UInt>

Number of users whose membership status is invite. Required if field has changed since last sync; otherwise, it may be omitted.

Implementations

impl RoomSummary

pub fn new() -> RoomSummary

Creates an empty RoomSummary.

pub fn is_empty(&self) -> bool

Returns true if there are no room summary updates.

Trait Implementations

impl Clone for RoomSummary

fn clone(&self) -> RoomSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomSummary

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

Formats the value using the given formatter.

impl Default for RoomSummary

fn default() -> RoomSummary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RoomSummary

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.