Enum ruma_client_api::uiaa::AuthData

#[non_exhaustive]
pub enum AuthData {
    Password(Password),
    ReCaptcha(ReCaptcha),
    EmailIdentity(EmailIdentity),
    Msisdn(Msisdn),
    Dummy(Dummy),
    RegistrationToken(RegistrationToken),
    FallbackAcknowledgement(FallbackAcknowledgement),
    Terms(Terms),
}

Available on crate features client or server only.

Information for one authentication stage.

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)

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

ReCaptcha(ReCaptcha)

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

EmailIdentity(EmailIdentity)

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

Msisdn(Msisdn)

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

Dummy(Dummy)

Dummy authentication (m.login.dummy).

RegistrationToken(RegistrationToken)

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

FallbackAcknowledgement(FallbackAcknowledgement)

Fallback acknowledgement.

Terms(Terms)

Terms of service (m.login.terms).

This type is only valid during account registration.

Implementations

impl AuthData

pub fn new( auth_type: &str, session: Option<String>, data: JsonObject, ) -> Result<Self>

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

Prefer to use the public variants of AuthData where possible; this constructor is meant to 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 AuthData variant fails.

pub fn fallback_acknowledgement(session: String) -> Self

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

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<'_, JsonObject>

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.

Trait Implementations

impl Clone for AuthData

fn clone(&self) -> AuthData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthData

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.