Struct Request

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

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

Request type for the create_room endpoint.

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: Vec<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: Vec<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: Vec<Invite3pid>

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<String>

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<String>

The desired room alias local part.

room_version: Option<RoomVersionId>

Room version to set for the room.

Defaults to homeserver’s default if not specified.

topic: Option<String>

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() -> Request

Creates a new Request will all-default parameters.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, FromHttpRequestError>

where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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

where T: Default + BufMut,

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