Struct RoomTombstoneEventContent

#[non_exhaustive]
pub struct RoomTombstoneEventContent {
    pub body: String,
    pub replacement_room: OwnedRoomId,
}

Available on crate feature events only.

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

body: String

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.

replacement_room: OwnedRoomId

The new room the client should be visiting.

Implementations

impl RoomTombstoneEventContent

pub fn new( body: String, replacement_room: OwnedRoomId, ) -> RoomTombstoneEventContent

Creates a new RoomTombstoneEventContent with the given body and replacement room ID.

Trait Implementations

impl Clone for RoomTombstoneEventContent

fn clone(&self) -> RoomTombstoneEventContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomTombstoneEventContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomTombstoneEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<RoomTombstoneEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomTombstoneEventContent

type EventType = StateEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> <RoomTombstoneEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.

impl From<RoomTombstoneEventContent> for AnyStateEventContent

fn from(c: RoomTombstoneEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl RedactContent for RoomTombstoneEventContent

type Redacted = RedactedRoomTombstoneEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedRoomTombstoneEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomTombstoneEventContent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateEventContent for RoomTombstoneEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl StaticEventContent for RoomTombstoneEventContent

const TYPE: &'static str = "m.room.tombstone"

The event type.

impl StaticStateEventContent for RoomTombstoneEventContent

type PossiblyRedacted = PossiblyRedactedRoomTombstoneEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<RoomTombstoneEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.