Struct ruma_client_api::r0::session::login::Request

pub struct Request {
    pub user: UserInfo,
    pub login_info: LoginInfo,
    pub device_id: Option<DeviceId>,
    pub initial_device_display_name: Option<String>,
}

Data for a request to the login API endpoint.

Login to the homeserver.

Fields

user: UserInfo

Identification information for the user.

login_info: LoginInfo

The authentication mechanism.

device_id: Option<DeviceId>

ID of the client device

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.

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

Formats the value using the given formatter.

impl Endpoint for Request

type Response = Response

Data returned in a successful response from the endpoint.

type ResponseError = Error

Error type returned when response from endpoint fails.

const METADATA: Metadata

Metadata for the #name endpoint.

impl Outgoing for Request

type Incoming = Self

The 'Incoming' variant of Self.

impl TryFrom<Request<Vec<u8>>> for Request

type Error = FromHttpRequestError

The type returned in the event of a conversion error.

fn try_from(request: Request<Vec<u8>>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = IntoHttpError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.