Struct ruma::directory::PublicRoomsChunk
source · [−]pub struct PublicRoomsChunk {
pub canonical_alias: Option<OwnedRoomAliasId>,
pub name: Option<String>,
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,
pub room_type: Option<RoomType>,
}
Expand description
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
canonical_alias: Option<OwnedRoomAliasId>
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: 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.
room_type: Option<RoomType>
unstable-msc3827
only.The type of room from m.room.create
, if any.
This field uses the unstable prefix from MSC3827.
Trait Implementations
sourceimpl Clone for PublicRoomsChunk
impl Clone for PublicRoomsChunk
sourcefn clone(&self) -> PublicRoomsChunk
fn clone(&self) -> PublicRoomsChunk
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more