ruma_events/room/
aliases.rs

1//! Types for the `m.room.aliases` event.
2
3use ruma_common::{OwnedRoomAliasId, OwnedServerName, RoomVersionId};
4use ruma_macros::EventContent;
5use serde::{Deserialize, Serialize};
6
7use crate::{EventContent, RedactContent, RedactedStateEventContent, StateEventType};
8
9/// The content of an `m.room.aliases` event.
10///
11/// Informs the room about what room aliases it has been given.
12#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
13#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
14#[ruma_event(type = "m.room.aliases", kind = State, state_key_type = OwnedServerName, custom_redacted)]
15pub struct RoomAliasesEventContent {
16    /// A list of room aliases.
17    pub aliases: Vec<OwnedRoomAliasId>,
18}
19
20impl RoomAliasesEventContent {
21    /// Create an `RoomAliasesEventContent` from the given aliases.
22    pub fn new(aliases: Vec<OwnedRoomAliasId>) -> Self {
23        Self { aliases }
24    }
25}
26
27impl RedactContent for RoomAliasesEventContent {
28    type Redacted = RedactedRoomAliasesEventContent;
29
30    fn redact(self, version: &RoomVersionId) -> RedactedRoomAliasesEventContent {
31        // We compare the long way to avoid pre version 6 behavior if/when
32        // a new room version is introduced.
33        let aliases = match version {
34            RoomVersionId::V1
35            | RoomVersionId::V2
36            | RoomVersionId::V3
37            | RoomVersionId::V4
38            | RoomVersionId::V5 => Some(self.aliases),
39            _ => None,
40        };
41
42        RedactedRoomAliasesEventContent { aliases }
43    }
44}
45
46/// An aliases event that has been redacted.
47#[derive(Clone, Debug, Default, Deserialize, Serialize)]
48#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
49pub struct RedactedRoomAliasesEventContent {
50    /// A list of room aliases.
51    ///
52    /// According to the Matrix spec version 1 redaction rules allowed this field to be
53    /// kept after redaction, this was changed in version 6.
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub aliases: Option<Vec<OwnedRoomAliasId>>,
56}
57
58impl RedactedRoomAliasesEventContent {
59    /// Create a `RedactedAliasesEventContent` with the given aliases.
60    ///
61    /// This is only valid for room version 5 and below.
62    pub fn new_v1(aliases: Vec<OwnedRoomAliasId>) -> Self {
63        Self { aliases: Some(aliases) }
64    }
65
66    /// Create a `RedactedAliasesEventContent` with the given aliases.
67    ///
68    /// This is only valid for room version 6 and above.
69    pub fn new_v6() -> Self {
70        Self::default()
71    }
72}
73
74impl EventContent for RedactedRoomAliasesEventContent {
75    type EventType = StateEventType;
76
77    fn event_type(&self) -> StateEventType {
78        StateEventType::RoomAliases
79    }
80}
81
82impl RedactedStateEventContent for RedactedRoomAliasesEventContent {
83    type StateKey = OwnedServerName;
84}
ruma_events/room/aliases.rs

ruma_events/room/
aliases.rs
