Enum ruma::api::client::session::login::v3::IncomingLoginInfo

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

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

‘Incoming’ variant of LoginInfo.

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: Map<String, Value>
) -> Result<IncomingLoginInfo, Error>

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<(), Error>

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.