Enum ruma_client_api::r0::uiaa::AuthData

#[non_exhaustive]
pub enum AuthData<'a> {
    Password(Password<'a>),
    ReCaptcha(ReCaptcha<'a>),
    Token(Token<'a>),
    OAuth2(OAuth2<'a>),
    EmailIdentity(EmailIdentity<'a>),
    Msisdn(Msisdn<'a>),
    Dummy(Dummy<'a>),
    FallbackAcknowledgement(FallbackAcknowledgement<'a>),
    // some variants omitted
}

Additional authentication information for the user-interactive authentication API.

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

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

Tuple Fields of Password

0: Password<'a>

ReCaptcha

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

Tuple Fields of ReCaptcha

0: ReCaptcha<'a>

Token

Token-based authentication (m.login.token).

Tuple Fields of Token

0: Token<'a>

OAuth2

OAuth2-based authentication (m.login.oauth2).

Tuple Fields of OAuth2

0: OAuth2<'a>

EmailIdentity

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

Tuple Fields of EmailIdentity

0: EmailIdentity<'a>

Msisdn

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

Tuple Fields of Msisdn

0: Msisdn<'a>

Dummy

Dummy authentication (m.login.dummy).

Tuple Fields of Dummy

0: Dummy<'a>

FallbackAcknowledgement

Fallback acknowledgement.

Tuple Fields of FallbackAcknowledgement

0: FallbackAcknowledgement<'a>

Implementations

impl<'a> AuthData<'a>

pub fn fallback_acknowledgement(session: &'a str) -> Self

Creates a new AuthData::FallbackAcknowledgement with the given session key.

pub fn auth_type(&self) -> Option<&'a str>

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

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

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

Trait Implementations

impl<'a> Clone for AuthData<'a>

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

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for AuthData<'a>

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

Formats the value using the given formatter.

impl<'a> Outgoing for AuthData<'a>

type Incoming = IncomingAuthData

The ‘Incoming’ variant of Self.

impl<'a> Serialize for AuthData<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.