Struct CreationContent

#[non_exhaustive]
pub struct CreationContent {
    pub federate: bool,
    pub predecessor: Option<PreviousRoom>,
    pub room_type: Option<RoomType>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Extra options to be added to the m.room.create event.

This is the same as the event content struct for m.room.create, but without some fields that servers are supposed to ignore.

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.

federate: bool

Whether users on other servers can join this room.

Defaults to true if key does not exist.

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 CreationContent

pub fn new() -> CreationContent

Creates a new CreationContent with all fields defaulted.

pub fn into_event_content( self, creator: OwnedUserId, room_version: RoomVersionId, ) -> RoomCreateEventContent

Given a CreationContent and the other fields that a homeserver has to fill, construct a RoomCreateEventContent.

pub fn is_empty(&self) -> bool

Returns whether all fields have their default value.

Trait Implementations

impl Clone for CreationContent

fn clone(&self) -> CreationContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreationContent

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

Formats the value using the given formatter.

impl Default for CreationContent

fn default() -> CreationContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreationContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreationContent

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.