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

pub struct Request {
    pub password: String,
    pub medium: Option<Medium>,
    pub login_type: LoginType,
    pub user: String,
    pub address: Option<String>,
    pub device_id: Option<String>,
}

Data for a request to the login API endpoint.

Login to the homeserver.

Fields

password: String

The user's password.

medium: Option<Medium>

When logging in using a third party identifier, the medium of the identifier.

login_type: LoginType

The authentication mechanism.

user: String

The fully qualified user ID or just local part of the user ID.

address: Option<String>

Third party identifier for the user.

device_id: Option<String>

ID of the client 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.

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 = Error

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 = Error

The type returned in the event of a conversion error.

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

Performs the conversion.