Enum ruma::api::client::session::get_login_types::v3::LoginType

pub enum LoginType {
    Password(PasswordLoginType),
    Token(TokenLoginType),
    Sso(SsoLoginType),
    // some variants omitted
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

An authentication mechanism.

Variants

Password(PasswordLoginType)

A password is supplied to authenticate.

Token(TokenLoginType)

Token-based login.

Sso(SsoLoginType)

SSO-based login.

Implementations

impl LoginType

pub fn new(
    login_type: &str,
    data: Map<String, Value>
) -> Result<LoginType, Error>

Creates a new LoginType with the given login_type string and data.

Prefer to use the public variants of LoginType where possible; this constructor is meant be used for unsupported login types only and does not allow setting arbitrary data for supported ones.

pub fn login_type(&self) -> &str

Returns a reference to the login_type string.

pub fn data(&self) -> Cow<'_, Map<String, Value>>

Returns the associated data.

Prefer to use the public variants of LoginType where possible; this method is meant to be used for unsupported login types only.

Trait Implementations

impl Clone for LoginType

fn clone(&self) -> LoginType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoginType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginType

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

Deserialize this value from the given Serde deserializer.

impl Serialize for LoginType

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

Serialize this value into the given Serde serializer.