Struct ruma::api::client::r0::uiaa::UiaaInfo[][src]

pub struct UiaaInfo {
    pub flows: Vec<AuthFlow, Global>,
    pub completed: Vec<String, Global>,
    pub params: Box<RawValue, Global>,
    pub session: Option<String>,
    pub auth_error: Option<ErrorBody>,
}
This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.
Expand description

Information about available authentication flows and status for User-Interactive Authenticiation API.

Fields

flows: Vec<AuthFlow, Global>

List of authentication flows available for this endpoint.

completed: Vec<String, Global>

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

params: Box<RawValue, Global>

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<ErrorBody>

Authentication-related errors for previous request returned by homeserver.

Implementations

Creates a new UiaaInfo with the given flows and parameters.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more