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