pub struct Request {
    pub bind_email: Option<bool>,
    pub password: Option<String>,
    pub username: Option<String>,
    pub device_id: Option<String>,
    pub initial_device_display_name: Option<String>,
    pub auth: Option<AuthenticationData>,
    pub kind: Option<RegistrationKind>,
}
Expand description

Data for a request to this API endpoint.

Fields§

§bind_email: Option<bool>

If true, the server binds the email used for authentication to the Matrix ID with the ID Server.

§password: Option<String>

The desired password for the account.

Should only be empty for guest accounts.

§username: Option<String>

local part of the desired Matrix ID.

If omitted, the homeserver MUST generate a Matrix ID local part.

§device_id: Option<String>

ID of the client device.

If this does not correspond to a known client device, a new device will be created. The server will auto-generate a device_id if this is not specified.

§initial_device_display_name: Option<String>

A display name to assign to the newly-created device.

Ignored if device_id corresponds to a known device.

§auth: Option<AuthenticationData>

Additional authentication information for the user-interactive authentication API.

Note that this information is not used to define how the registered user should be authenticated, but is instead used to authenticate the register call itself. It should be left empty, or omitted, unless an earlier call returned an response with status code 401.

§kind: Option<RegistrationKind>

Kind of account to register

Defaults to User if ommited.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
The future for the conversion.
Possible errors during conversion.
Consume the given value, beginning the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.