Enum ruma::api::client::uiaa::IncomingAuthData

#[non_exhaustive]
pub enum IncomingAuthData {
    Password(IncomingPassword),
    ReCaptcha(IncomingReCaptcha),
    EmailIdentity(IncomingEmailIdentity),
    Msisdn(IncomingMsisdn),
    Dummy(IncomingDummy),
    RegistrationToken(IncomingRegistrationToken),
    FallbackAcknowledgement(IncomingFallbackAcknowledgement),
    // 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 AuthData.

Variants (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)

Password-based authentication (m.login.password).

ReCaptcha(IncomingReCaptcha)

Google ReCaptcha 2.0 authentication (m.login.recaptcha).

EmailIdentity(IncomingEmailIdentity)

Email-based authentication (m.login.email.identity).

Msisdn(IncomingMsisdn)

Phone number-based authentication (m.login.msisdn).

Dummy(IncomingDummy)

Dummy authentication (m.login.dummy).

RegistrationToken(IncomingRegistrationToken)

Registration token-based authentication (m.login.registration_token).

FallbackAcknowledgement(IncomingFallbackAcknowledgement)

Fallback acknowledgement.

Implementations

impl IncomingAuthData

pub fn new(
    auth_type: &str,
    session: Option<String>,
    data: Map<String, Value>
) -> Result<IncomingAuthData, Error>

Creates a new IncomingAuthData with the given auth_type string, session and data.

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

Errors

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

pub fn auth_type(&self) -> Option<AuthType>

Returns the value of the type field, if it exists.

pub fn session(&self) -> Option<&str>

Returns the value of the session field, if it exists.

pub fn data(&self) -> Cow<'_, Map<String, Value>>

Returns the associated data.

The returned JSON object won’t contain the type and session fields, use .auth_type() / .session() to access those.

Prefer to use the public variants of AuthData where possible; this method is meant to be used for custom auth types only.

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

Convert IncomingAuthData to AuthData.

Trait Implementations

impl Debug for IncomingAuthData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncomingAuthData

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

Deserialize this value from the given Serde deserializer.