Struct ruma::events::room::create::RoomCreateEventContent

#[non_exhaustive]
pub struct RoomCreateEventContent {
    pub creator: Option<OwnedUserId>,
    pub federate: bool,
    pub room_version: RoomVersionId,
    pub predecessor: Option<PreviousRoom>,
    pub room_type: Option<RoomType>,
}

The content of an m.room.create event.

This is the first event in a room and cannot be changed.

It acts as the root of all other events.

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.

creator: Option<OwnedUserId>

👎Deprecated: Since Matrix 1.8. This field was removed in Room version 11, clients should use the event’s sender instead

The user_id of the room creator.

This is set by the homeserver.

This is required in room versions 1 trough 10, but is removed starting from room version 11.

federate: bool

Whether or not this room’s data should be transferred to other homeservers.

room_version: RoomVersionId

The version of the room.

Defaults to RoomVersionId::V1.

predecessor: Option<PreviousRoom>

A reference to the room this room replaces, if the previous room was upgraded.

room_type: Option<RoomType>

The room type.

This is currently only used for spaces.

Implementations

impl RoomCreateEventContent

pub fn new_v1(creator: OwnedUserId) -> RoomCreateEventContent

Creates a new RoomCreateEventContent with the given creator, as required for room versions 1 through 10.

pub fn new_v11() -> RoomCreateEventContent

Creates a new RoomCreateEventContent with the default values and no creator, as introduced in room version 11.

The room version is set to RoomVersionId::V11.

Trait Implementations

impl Clone for RoomCreateEventContent

fn clone(&self) -> RoomCreateEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomCreateEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomCreateEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomCreateEventContent

type EventType = StateEventType

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

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

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

impl From<RoomCreateEventContent> for AnyStateEventContent

fn from(c: RoomCreateEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl PossiblyRedactedStateEventContent for RoomCreateEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl RedactContent for RoomCreateEventContent

type Redacted = RoomCreateEventContent

The redacted form of the event’s content.

fn redact( self, version: &RoomVersionId, ) -> <RoomCreateEventContent as RedactContent>::Redacted

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

impl RedactedStateEventContent for RoomCreateEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl Serialize for RoomCreateEventContent

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 RoomCreateEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl StaticEventContent for RoomCreateEventContent

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

The event type.

impl StaticStateEventContent for RoomCreateEventContent

type PossiblyRedacted = RoomCreateEventContent

The possibly redacted form of the event’s content.

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

The type of the event’s unsigned field.