Struct ruma_common::directory::PublicRoomsChunk

#[non_exhaustive]
pub struct PublicRoomsChunk {
    pub canonical_alias: Option<OwnedRoomAliasId>,
    pub name: Option<Box<RoomName>>,
    pub num_joined_members: UInt,
    pub room_id: OwnedRoomId,
    pub topic: Option<String>,
    pub world_readable: bool,
    pub guest_can_join: bool,
    pub avatar_url: Option<OwnedMxcUri>,
    pub join_rule: PublicRoomJoinRule,
}

A chunk of a room list response, describing one room.

To create an instance of this type, first create a PublicRoomsChunkInit and convert it via PublicRoomsChunk::from / .into().

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.

canonical_alias: Option<OwnedRoomAliasId>

The canonical alias of the room, if any.

name: Option<Box<RoomName>>

The name of the room, if any.

num_joined_members: UInt

The number of members joined to the room.

room_id: OwnedRoomId

The ID of the room.

topic: Option<String>

The topic of the room, if any.

world_readable: bool

Whether the room may be viewed by guest users without joining.

guest_can_join: bool

Whether guest users may join the room and participate in it.

If they can, they will be subject to ordinary power level rules like any other user.

avatar_url: Option<OwnedMxcUri>

The URL for the room’s avatar, if one is set.

If you activate the compat feature, this field being an empty string in JSON will result in None here during deserialization.

join_rule: PublicRoomJoinRule

The join rule of the room.

Trait Implementations

impl Clone for PublicRoomsChunk

fn clone(&self) -> PublicRoomsChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicRoomsChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicRoomsChunk

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

Deserialize this value from the given Serde deserializer.

impl From<PublicRoomsChunkInit> for PublicRoomsChunk

fn from(init: PublicRoomsChunkInit) -> Self

Converts to this type from the input type.

impl Serialize for PublicRoomsChunk

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.