Struct matrix_sdk_base::ruma::api::client::uiaa::AuthFlow

#[non_exhaustive]
pub struct AuthFlow {
    pub stages: Vec<AuthType>,
}

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

Description of steps required to authenticate via the User-Interactive Authentication API.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stages: Vec<AuthType>

Ordered list of stages required to complete authentication.

Implementations

impl AuthFlow

pub fn new(stages: Vec<AuthType>) -> AuthFlow

Creates a new AuthFlow with the given stages.

To create an empty AuthFlow, use AuthFlow::default().

Trait Implementations

impl Clone for AuthFlow

fn clone(&self) -> AuthFlow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthFlow

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

Formats the value using the given formatter.

impl Default for AuthFlow

fn default() -> AuthFlow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthFlow

fn deserialize<__D>( __deserializer: __D, ) -> Result<AuthFlow, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthFlow

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.