Enum ruma_client_api::uiaa::IncomingAuthData

source · [−]

#[non_exhaustive]
pub enum IncomingAuthData {
    Password(IncomingPassword),
    ReCaptcha(IncomingReCaptcha),
    EmailIdentity(IncomingEmailIdentity),
    Msisdn(IncomingMsisdn),
    Dummy(IncomingDummy),
    RegistrationToken(IncomingRegistrationToken),
    FallbackAcknowledgement(IncomingFallbackAcknowledgement),
    // some variants omitted
}

Expand description

‘Incoming’ variant of AuthData.

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(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: JsonObject
) -> Result<Self>

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

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

Convert IncomingAuthData to AuthData.

Trait Implementations

impl Debug for IncomingAuthData

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

Formats the value using the given formatter. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for IncomingAuthData

impl Send for IncomingAuthData

impl Sync for IncomingAuthData

impl Unpin for IncomingAuthData

impl UnwindSafe for IncomingAuthData

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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