Struct SpaceHierarchyRoomsChunk

#[non_exhaustive]
pub struct SpaceHierarchyRoomsChunk {
    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: SpaceRoomJoinRule,
    pub room_type: Option<RoomType>,
    pub children_state: Vec<Raw<HierarchySpaceChildEvent>>,
}

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

A chunk of a space hierarchy response, describing one room.

To create an instance of this type, first create a SpaceHierarchyRoomsChunkInit and convert it via SpaceHierarchyRoomsChunk::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<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-empty-string-null feature, this field being an empty string in JSON will result in None here during deserialization.

join_rule: SpaceRoomJoinRule

The join rule of the room.

room_type: Option<RoomType>

The type of room from m.room.create, if any.

children_state: Vec<Raw<HierarchySpaceChildEvent>>

The stripped m.space.child events of the space-room.

If the room is not a space-room, this should be empty.

Trait Implementations

impl Clone for SpaceHierarchyRoomsChunk

fn clone(&self) -> SpaceHierarchyRoomsChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpaceHierarchyRoomsChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpaceHierarchyRoomsChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpaceHierarchyRoomsChunkInit> for SpaceHierarchyRoomsChunk

fn from(init: SpaceHierarchyRoomsChunkInit) -> SpaceHierarchyRoomsChunk

Converts to this type from the input type.

impl Serialize for SpaceHierarchyRoomsChunk

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.