ruma_client_api/
space.rs

1//! Endpoints for spaces.
2//!
3//! See the [Matrix specification][spec] for more details about spaces.
4//!
5//! [spec]: https://spec.matrix.org/latest/client-server-api/#spaces
6
7use js_int::UInt;
8use ruma_common::{
9    room::RoomType, serde::Raw, space::SpaceRoomJoinRule, OwnedMxcUri, OwnedRoomAliasId,
10    OwnedRoomId,
11};
12use ruma_events::space::child::HierarchySpaceChildEvent;
13use serde::{Deserialize, Serialize};
14
15pub mod get_hierarchy;
16
17/// A chunk of a space hierarchy response, describing one room.
18///
19/// To create an instance of this type, first create a `SpaceHierarchyRoomsChunkInit` and convert it
20/// via `SpaceHierarchyRoomsChunk::from` / `.into()`.
21#[derive(Clone, Debug, Deserialize, Serialize)]
22#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
23pub struct SpaceHierarchyRoomsChunk {
24    /// The canonical alias of the room, if any.
25    #[serde(skip_serializing_if = "Option::is_none")]
26    #[cfg_attr(
27        feature = "compat-empty-string-null",
28        serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
29    )]
30    pub canonical_alias: Option<OwnedRoomAliasId>,
31
32    /// The name of the room, if any.
33    #[serde(skip_serializing_if = "Option::is_none")]
34    pub name: Option<String>,
35
36    /// The number of members joined to the room.
37    pub num_joined_members: UInt,
38
39    /// The ID of the room.
40    pub room_id: OwnedRoomId,
41
42    /// The topic of the room, if any.
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub topic: Option<String>,
45
46    /// Whether the room may be viewed by guest users without joining.
47    pub world_readable: bool,
48
49    /// Whether guest users may join the room and participate in it.
50    ///
51    /// If they can, they will be subject to ordinary power level rules like any other user.
52    pub guest_can_join: bool,
53
54    /// The URL for the room's avatar, if one is set.
55    ///
56    /// If you activate the `compat-empty-string-null` feature, this field being an empty string in
57    /// JSON will result in `None` here during deserialization.
58    #[serde(skip_serializing_if = "Option::is_none")]
59    #[cfg_attr(
60        feature = "compat-empty-string-null",
61        serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
62    )]
63    pub avatar_url: Option<OwnedMxcUri>,
64
65    /// The join rule of the room.
66    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
67    pub join_rule: SpaceRoomJoinRule,
68
69    /// The type of room from `m.room.create`, if any.
70    #[serde(skip_serializing_if = "Option::is_none")]
71    pub room_type: Option<RoomType>,
72
73    /// The stripped `m.space.child` events of the space-room.
74    ///
75    /// If the room is not a space-room, this should be empty.
76    pub children_state: Vec<Raw<HierarchySpaceChildEvent>>,
77}
78
79/// Initial set of mandatory fields of `SpaceHierarchyRoomsChunk`.
80///
81/// This struct will not be updated even if additional fields are added to
82/// `SpaceHierarchyRoomsChunk` in a new (non-breaking) release of the Matrix specification.
83#[derive(Debug)]
84#[allow(clippy::exhaustive_structs)]
85pub struct SpaceHierarchyRoomsChunkInit {
86    /// The number of members joined to the room.
87    pub num_joined_members: UInt,
88
89    /// The ID of the room.
90    pub room_id: OwnedRoomId,
91
92    /// Whether the room may be viewed by guest users without joining.
93    pub world_readable: bool,
94
95    /// Whether guest users may join the room and participate in it.
96    ///
97    /// If they can, they will be subject to ordinary power level rules like any other user.
98    pub guest_can_join: bool,
99
100    /// The join rule of the room.
101    pub join_rule: SpaceRoomJoinRule,
102
103    /// The stripped `m.space.child` events of the space-room.
104    ///
105    /// If the room is not a space-room, this should be empty.
106    pub children_state: Vec<Raw<HierarchySpaceChildEvent>>,
107}
108
109impl From<SpaceHierarchyRoomsChunkInit> for SpaceHierarchyRoomsChunk {
110    fn from(init: SpaceHierarchyRoomsChunkInit) -> Self {
111        let SpaceHierarchyRoomsChunkInit {
112            num_joined_members,
113            room_id,
114            world_readable,
115            guest_can_join,
116            join_rule,
117            children_state,
118        } = init;
119
120        Self {
121            canonical_alias: None,
122            name: None,
123            num_joined_members,
124            room_id,
125            topic: None,
126            world_readable,
127            guest_can_join,
128            avatar_url: None,
129            join_rule,
130            room_type: None,
131            children_state,
132        }
133    }
134}
ruma_client_api/space.rs

ruma_client_api/
space.rs
