73 lines
2.4 KiB
Rust
73 lines
2.4 KiB
Rust
//! Types for the [`m.room.tombstone`] event.
|
|
//!
|
|
//! [`m.room.tombstone`]: https://spec.matrix.org/latest/client-server-api/#mroomtombstone
|
|
|
|
use ruma_common::OwnedRoomId;
|
|
use ruma_macros::EventContent;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::{
|
|
EmptyStateKey, EventContent, PossiblyRedactedStateEventContent, StateEventType,
|
|
StaticEventContent,
|
|
};
|
|
|
|
/// The content of an `m.room.tombstone` event.
|
|
///
|
|
/// A state event signifying that a room has been upgraded to a different room version, and that
|
|
/// clients should go there.
|
|
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
|
|
#[ruma_event(
|
|
type = "m.room.tombstone",
|
|
kind = State,
|
|
state_key_type = EmptyStateKey,
|
|
custom_possibly_redacted,
|
|
)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
pub struct RoomTombstoneEventContent {
|
|
/// A server-defined message.
|
|
///
|
|
/// If the `compat-optional` feature is enabled, this field being absent in JSON will result
|
|
/// in an empty string instead of an error when deserializing.
|
|
#[cfg_attr(feature = "compat-optional", serde(default))]
|
|
pub body: String,
|
|
|
|
/// The new room the client should be visiting.
|
|
pub replacement_room: OwnedRoomId,
|
|
}
|
|
|
|
impl RoomTombstoneEventContent {
|
|
/// Creates a new `RoomTombstoneEventContent` with the given body and replacement room ID.
|
|
pub fn new(body: String, replacement_room: OwnedRoomId) -> Self {
|
|
Self { body, replacement_room }
|
|
}
|
|
}
|
|
|
|
/// The possibly redacted form of [`RoomTombstoneEventContent`].
|
|
///
|
|
/// This type is used when it's not obvious whether the content is redacted or not.
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
pub struct PossiblyRedactedRoomTombstoneEventContent {
|
|
/// A server-defined message.
|
|
pub body: Option<String>,
|
|
|
|
/// The new room the client should be visiting.
|
|
pub replacement_room: Option<OwnedRoomId>,
|
|
}
|
|
|
|
impl EventContent for PossiblyRedactedRoomTombstoneEventContent {
|
|
type EventType = StateEventType;
|
|
|
|
fn event_type(&self) -> Self::EventType {
|
|
StateEventType::RoomTombstone
|
|
}
|
|
}
|
|
|
|
impl PossiblyRedactedStateEventContent for PossiblyRedactedRoomTombstoneEventContent {
|
|
type StateKey = EmptyStateKey;
|
|
}
|
|
|
|
impl StaticEventContent for PossiblyRedactedRoomTombstoneEventContent {
|
|
const TYPE: &'static str = "m.room.tombstone";
|
|
}
|