Struct ruma::directory::PublicRoomsChunk

pub struct PublicRoomsChunk {
    pub aliases: Vec<RoomAliasId, Global>,
    pub canonical_alias: Option<RoomAliasId>,
    pub name: Option<String>,
    pub num_joined_members: UInt,
    pub room_id: RoomId,
    pub topic: Option<String>,
    pub world_readable: bool,
    pub guest_can_join: bool,
    pub avatar_url: Option<MxcUri>,
}

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

aliases: Vec<RoomAliasId, Global>

Aliases of the room.

canonical_alias: Option<RoomAliasId>

The canonical alias of the room, if any.

name: Option<String>

The name of the room, if any.

num_joined_members: UInt

The number of members joined to the room.

room_id: RoomId

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<MxcUri>

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 give you None here.

Trait Implementations

impl Clone for PublicRoomsChunk

pub 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

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl From<PublicRoomsChunkInit> for PublicRoomsChunk

pub fn from(init: PublicRoomsChunkInit) -> PublicRoomsChunk

Performs the conversion.

impl Serialize for PublicRoomsChunk

pub 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.