Enum ruma_client_api::r0::uiaa::AuthData

#[non_exhaustive]
pub enum AuthData<'a> {
    DirectRequest {
        kind: &'a str,
        session: Option<&'a str>,
        auth_parameters: BTreeMap<String, JsonValue>,
    },
    FallbackAcknowledgement {
        session: &'a str,
    },
}

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.

DirectRequest

Used for sending UIAA authentication requests to the homeserver directly from the client.

Fields of DirectRequest

kind: &'a str

The login type that the client is attempting to complete.

session: Option<&'a str>

The value of the session key given by the homeserver.

auth_parameters: BTreeMap<String, JsonValue>

Parameters submitted for a particular authentication stage.

FallbackAcknowledgement

Used by the client to acknowledge that the user has completed a UIAA stage through the fallback method.

Fields of FallbackAcknowledgement

session: &'a str

The value of the session key given by the homeserver.

Implementations

impl<'a> AuthData<'a>

pub fn direct_request(kind: &'a str) -> Self

Creates a new AuthData::DirectRequest with the given login type.

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

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

Trait Implementations

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

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

Returns a copy of the value.

pub 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.