Struct ruma_client_api::room::create_room::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub creation_content: Option<Raw<CreationContent>>,
    pub initial_state: &'a [Raw<AnyInitialStateEvent>],
    pub invite: &'a [OwnedUserId],
    pub invite_3pid: &'a [Invite3pid<'a>],
    pub is_direct: bool,
    pub name: Option<&'a RoomName>,
    pub power_level_content_override: Option<Raw<RoomPowerLevelsEventContent>>,
    pub preset: Option<RoomPreset>,
    pub room_alias_name: Option<&'a str>,
    pub room_version: Option<&'a RoomVersionId>,
    pub topic: Option<&'a str>,
    pub visibility: Visibility,
}

Data for a request to the create_room API endpoint.

Create a new room.

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.

creation_content: Option<Raw<CreationContent>>

Extra keys to be added to the content of the m.room.create.

initial_state: &'a [Raw<AnyInitialStateEvent>]

List of state events to send to the new room.

Takes precedence over events set by preset, but gets overridden by name and topic keys.

invite: &'a [OwnedUserId]

A list of user IDs to invite to the room.

This will tell the server to invite everyone in the list to the newly created room.

invite_3pid: &'a [Invite3pid<'a>]

List of third party IDs of users to invite.

is_direct: bool

If set, this sets the is_direct flag on room invites.

name: Option<&'a RoomName>

If this is included, an m.room.name event will be sent into the room to indicate the name of the room.

power_level_content_override: Option<Raw<RoomPowerLevelsEventContent>>

Power level content to override in the default power level event.

preset: Option<RoomPreset>

Convenience parameter for setting various default state events based on a preset.

room_alias_name: Option<&'a str>

The desired room alias local part.

room_version: Option<&'a RoomVersionId>

Room version to set for the room.

Defaults to homeserver’s default if not specified.

topic: Option<&'a str>

If this is included, an m.room.topic event will be sent into the room to indicate the topic for the room.

visibility: Visibility

A public visibility indicates that the room will be shown in the published room list.

A private visibility will hide the room from the published room list. Defaults to Private.

Implementations

impl Request<'_>

pub fn new() -> Self

Creates a new Request will all-default parameters.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

fn default() -> Request<'a>

Returns the “default value” for a type.

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_into_http_request<T: Default + BufMut>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>

Tries to convert this request into an http::Request.