107 lines
3.4 KiB
Rust
107 lines
3.4 KiB
Rust
//! Types for the `m.room.aliases` event.
|
|
|
|
use ruma_identifiers::{RoomAliasId, RoomVersionId};
|
|
use ruma_macros::EventContent;
|
|
use serde::{Deserialize, Serialize};
|
|
use serde_json::value::RawValue as RawJsonValue;
|
|
|
|
use crate::{
|
|
EventContent, HasDeserializeFields, RedactContent, RedactedEventContent,
|
|
RedactedStateEventContent,
|
|
};
|
|
|
|
/// The content of an `m.room.aliases` event.
|
|
///
|
|
/// Informs the room about what room aliases it has been given.
|
|
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
#[ruma_event(type = "m.room.aliases", kind = State, custom_redacted)]
|
|
pub struct RoomAliasesEventContent {
|
|
/// A list of room aliases.
|
|
pub aliases: Vec<Box<RoomAliasId>>,
|
|
}
|
|
|
|
impl RoomAliasesEventContent {
|
|
/// Create an `RoomAliasesEventContent` from the given aliases.
|
|
pub fn new(aliases: Vec<Box<RoomAliasId>>) -> Self {
|
|
Self { aliases }
|
|
}
|
|
}
|
|
|
|
impl RedactContent for RoomAliasesEventContent {
|
|
type Redacted = RedactedRoomAliasesEventContent;
|
|
|
|
fn redact(self, version: &RoomVersionId) -> RedactedRoomAliasesEventContent {
|
|
// We compare the long way to avoid pre version 6 behavior if/when
|
|
// a new room version is introduced.
|
|
let aliases = match version {
|
|
RoomVersionId::V1
|
|
| RoomVersionId::V2
|
|
| RoomVersionId::V3
|
|
| RoomVersionId::V4
|
|
| RoomVersionId::V5 => Some(self.aliases),
|
|
_ => None,
|
|
};
|
|
|
|
RedactedRoomAliasesEventContent { aliases }
|
|
}
|
|
}
|
|
|
|
/// An aliases event that has been redacted.
|
|
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
pub struct RedactedRoomAliasesEventContent {
|
|
/// A list of room aliases.
|
|
///
|
|
/// According to the Matrix spec version 1 redaction rules allowed this field to be
|
|
/// kept after redaction, this was changed in version 6.
|
|
pub aliases: Option<Vec<Box<RoomAliasId>>>,
|
|
}
|
|
|
|
impl RedactedRoomAliasesEventContent {
|
|
/// Create a `RedactedAliasesEventContent` with the given aliases.
|
|
///
|
|
/// This is only valid for room version 5 and below.
|
|
pub fn new_v1(aliases: Vec<Box<RoomAliasId>>) -> Self {
|
|
Self { aliases: Some(aliases) }
|
|
}
|
|
|
|
/// Create a `RedactedAliasesEventContent` with the given aliases.
|
|
///
|
|
/// This is only valid for room version 6 and above.
|
|
pub fn new_v6() -> Self {
|
|
Self::default()
|
|
}
|
|
}
|
|
|
|
impl EventContent for RedactedRoomAliasesEventContent {
|
|
fn event_type(&self) -> &str {
|
|
"m.room.aliases"
|
|
}
|
|
|
|
fn from_parts(event_type: &str, content: &RawJsonValue) -> serde_json::Result<Self> {
|
|
if event_type != "m.room.aliases" {
|
|
return Err(::serde::de::Error::custom(format!(
|
|
"expected event type `m.room.aliases`, found `{}`",
|
|
event_type
|
|
)));
|
|
}
|
|
|
|
serde_json::from_str(content.get())
|
|
}
|
|
}
|
|
|
|
// Since this redacted event has fields we leave the default `empty` method
|
|
// that will error if called.
|
|
impl RedactedEventContent for RedactedRoomAliasesEventContent {
|
|
fn has_serialize_fields(&self) -> bool {
|
|
self.aliases.is_some()
|
|
}
|
|
|
|
fn has_deserialize_fields() -> HasDeserializeFields {
|
|
HasDeserializeFields::Optional
|
|
}
|
|
}
|
|
|
|
impl RedactedStateEventContent for RedactedRoomAliasesEventContent {}
|