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

#[non_exhaustive]
pub struct Request<'a> {
    pub login_info: LoginInfo<'a>,
    pub device_id: Option<&'a DeviceId>,
    pub initial_device_display_name: Option<&'a str>,
}

Data for a request to the login API endpoint.

Login to the homeserver.

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.

login_info: LoginInfo<'a>

The authentication mechanism.

device_id: Option<&'a DeviceId>

ID of the client device

initial_device_display_name: Option<&'a str>

A display name to assign to the newly-created device. Ignored if device_id corresponds to a known device.

Implementations

impl<'a> Request<'a>

pub fn new(login_info: LoginInfo<'a>) -> Self

Creates a new Request with the given login info.

Trait Implementations

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

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

Returns a copy of the value.

pub 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> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.