Enum matrix_sdk::ruma::api::client::session::login::v3::LoginInfo

#[non_exhaustive]
pub enum LoginInfo {
    Password(Password),
    Token(Token),
    ApplicationService(ApplicationService),
}

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

The authentication mechanism.

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)

An identifier and password are supplied to authenticate.

Token(Token)

Token-based login.

ApplicationService(ApplicationService)

Application Service-specific login.

Implementations

impl LoginInfo

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

Creates a new IncomingLoginInfo with the given login_type string, session and data.

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

Errors

Returns an error if the login_type is known and serialization of data to the corresponding IncomingLoginInfo variant fails.

Trait Implementations

impl Clone for LoginInfo

fn clone(&self) -> LoginInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoginInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginInfo

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LoginInfo

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.