Enum ruma_client_api::uiaa::AuthData

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

Information for one authentication stage.

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(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§

source§

impl AuthData

source

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.

source

pub fn fallback_acknowledgement(session: String) -> Self

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

source

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

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

source

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

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

source

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§

source§

impl Clone for AuthData

source§

fn clone(&self) -> AuthData

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for AuthData

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for AuthData

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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