ruma_events/space/
parent.rs

Help
1//! Types for the [`m.space.parent`] event.
2//!
3//! [`m.space.parent`]: https://spec.matrix.org/latest/client-server-api/#mspaceparent
4
5use ruma_common::{OwnedRoomId, OwnedServerName};
6use ruma_macros::EventContent;
7use serde::{Deserialize, Serialize};
8
9/// The content of an `m.space.parent` event.
10///
11/// Rooms can claim parents via the `m.space.parent` state event.
12///
13/// Similar to `m.space.child`, the `state_key` is the ID of the parent space, and the content must
14/// contain a `via` key which gives a list of candidate servers that can be used to join the
15/// parent.
16#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
17#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
18#[ruma_event(type = "m.space.parent", kind = State, state_key_type = OwnedRoomId)]
19pub struct SpaceParentEventContent {
20    /// List of candidate servers that can be used to join the room.
21    pub via: Vec<OwnedServerName>,
22
23    /// Determines whether this is the main parent for the space.
24    ///
25    /// When a user joins a room with a canonical parent, clients may switch to view the room in
26    /// the context of that space, peeking into it in order to find other rooms and group them
27    /// together. In practice, well behaved rooms should only have one `canonical` parent, but
28    /// given this is not enforced: if multiple are present the client should select the one with
29    /// the lowest room ID, as determined via a lexicographic ordering of the Unicode code-points.
30    ///
31    /// Defaults to `false`.
32    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
33    pub canonical: bool,
34}
35
36impl SpaceParentEventContent {
37    /// Creates a new `SpaceParentEventContent` with the given routing servers.
38    pub fn new(via: Vec<OwnedServerName>) -> Self {
39        Self { via, canonical: false }
40    }
41}
42
43#[cfg(test)]
44mod tests {
45    use ruma_common::server_name;
46    use serde_json::{json, to_value as to_json_value};
47
48    use super::SpaceParentEventContent;
49
50    #[test]
51    fn space_parent_serialization() {
52        let content = SpaceParentEventContent {
53            via: vec![server_name!("example.com").to_owned()],
54            canonical: true,
55        };
56
57        let json = json!({
58            "via": ["example.com"],
59            "canonical": true,
60        });
61
62        assert_eq!(to_json_value(&content).unwrap(), json);
63    }
64
65    #[test]
66    fn space_parent_empty_serialization() {
67        let content = SpaceParentEventContent { via: vec![], canonical: false };
68
69        let json = json!({ "via": [] });
70
71        assert_eq!(to_json_value(&content).unwrap(), json);
72    }
73}
ruma_events/space/parent.rs

ruma_events/space/
parent.rs
