Enum ruma_client_api::session::login::v3::IncomingLoginInfo

source · [−]

#[non_exhaustive]
pub enum IncomingLoginInfo {
    Password(IncomingPassword),
    Token(IncomingToken),
    ApplicationService(IncomingApplicationService),
    // some variants omitted
}

Expand description

‘Incoming’ variant of LoginInfo.

Variants (Non-exhaustive)

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

`Password(IncomingPassword)`

An identifier and password are supplied to authenticate.

`Token(IncomingToken)`

Token-based login.

`ApplicationService(IncomingApplicationService)`

Application Service-specific login.

Implementations

impl IncomingLoginInfo

pub fn new(login_type: &str, data: JsonObject) -> Result<Self>

Creates a new IncomingLoginInfo with the given login_type string, session and data.

Prefer to use the public variants of IncomingLoginInfo where possible; this constructor is meant be used for unsupported authentication mechanisms only and does not allow setting arbitrary data for supported ones.

Errors

Returns an error if the login_type is known and serialization of data to the corresponding IncomingLoginInfo variant fails.

pub fn to_outgoing(&self) -> LoginInfo<'_>

Convert IncomingLoginInfo to LoginInfo.

Trait Implementations

impl Debug for IncomingLoginInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for IncomingLoginInfo

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for IncomingLoginInfo

impl Send for IncomingLoginInfo

impl Sync for IncomingLoginInfo

impl Unpin for IncomingLoginInfo

impl UnwindSafe for IncomingLoginInfo

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,