Struct UiaaInfo 

#[non_exhaustive]
pub struct UiaaInfo {
    pub flows: Vec<AuthFlow>,
    pub completed: Vec<AuthType>,
    pub params: Option<Box<RawValue>>,
    pub session: Option<String>,
    pub auth_error: Option<StandardErrorBody>,
}

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

Information about available authentication flows and status for User-Interactive Authenticiation 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.

flows: Vec<AuthFlow>

List of authentication flows available for this endpoint.

completed: Vec<AuthType>

List of stages in the current flow completed by the client.

params: Option<Box<RawValue>>

Authentication parameters required for the client to complete authentication.

To create a Box<RawJsonValue>, use serde_json::value::to_raw_value.

session: Option<String>

Session key for client to use to complete authentication.

auth_error: Option<StandardErrorBody>

Authentication-related errors for previous request returned by homeserver.

Implementations

impl UiaaInfo

pub fn new(flows: Vec<AuthFlow>) -> UiaaInfo

Creates a new UiaaInfo with the given flows.

pub fn params<'a, T>(&'a self, auth_type: &AuthType) -> Result<Option<T>, Error>

where T: Deserialize<'a>,

Get the parameters for the given AuthType, if they are available in the params object.

Returns Ok(Some(_)) if the parameters for the authentication type were found and the deserialization worked, Ok(None) if the parameters for the authentication type were not found, and Err(_) if the parameters for the authentication type were found but their deserialization failed.

Example

use ruma_client_api::uiaa::{AuthType, LoginTermsParams};

let login_terms_params = uiaa_info.params::<LoginTermsParams>(&AuthType::Terms)?;

Trait Implementations

impl Clone for UiaaInfo

fn clone(&self) -> UiaaInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiaaInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UiaaInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UiaaInfo

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.