[][src]Struct ruma_client_api::r0::session::login::IncomingRequest

#[non_exhaustive]pub struct IncomingRequest {
    pub user: IncomingUserInfo,
    pub login_info: IncomingLoginInfo,
    pub device_id: Option<Box<DeviceId>>,
    pub initial_device_display_name: Option<String>,
}

'Incoming' variant of Request.

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.
user: IncomingUserInfo

Identification information for the user.

login_info: IncomingLoginInfo

The authentication mechanism.

device_id: Option<Box<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 Debug for IncomingRequest[src]

impl IncomingNonAuthRequest for IncomingRequest[src]

impl IncomingRequest for IncomingRequest[src]

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.

pub const METADATA: Metadata[src]

Metadata for the login API endpoint.

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.