Struct ruma_events::room::canonical_alias::RoomCanonicalAliasEventContent

#[non_exhaustive]
pub struct RoomCanonicalAliasEventContent {
    pub alias: Option<OwnedRoomAliasId>,
    pub alt_aliases: Vec<OwnedRoomAliasId>,
}

The content of an m.room.canonical_alias event.

Informs the room as to which alias is the canonical one.

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.

alias: Option<OwnedRoomAliasId>

The canonical alias.

Rooms with alias: None should be treated the same as a room with no canonical alias.

alt_aliases: Vec<OwnedRoomAliasId>

List of alternative aliases to the room.

Implementations

impl RoomCanonicalAliasEventContent

pub fn new() -> Self

Creates an empty RoomCanonicalAliasEventContent.

Trait Implementations

impl Clone for RoomCanonicalAliasEventContent

fn clone(&self) -> RoomCanonicalAliasEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomCanonicalAliasEventContent

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

Formats the value using the given formatter.

impl Default for RoomCanonicalAliasEventContent

fn default() -> RoomCanonicalAliasEventContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomCanonicalAliasEventContent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomCanonicalAliasEventContent

type EventType = StateEventType

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

fn event_type(&self) -> Self::EventType

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

impl From<RoomCanonicalAliasEventContent> for AnyStateEventContent

fn from(c: RoomCanonicalAliasEventContent) -> Self

Converts to this type from the input type.

impl PossiblyRedactedStateEventContent for RoomCanonicalAliasEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl RedactContent for RoomCanonicalAliasEventContent

type Redacted = RedactedRoomCanonicalAliasEventContent

The redacted form of the event’s content.

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

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

impl Serialize for RoomCanonicalAliasEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateEventContent for RoomCanonicalAliasEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl StaticEventContent for RoomCanonicalAliasEventContent

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

The event type.

impl StaticStateEventContent for RoomCanonicalAliasEventContent

type PossiblyRedacted = RoomCanonicalAliasEventContent

The possibly redacted form of the event’s content.

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

The type of the event’s unsigned field.