Struct ruma_client_api::uiaa::UiaaInfo
source · #[non_exhaustive]pub struct UiaaInfo {
pub flows: Vec<AuthFlow>,
pub completed: Vec<AuthType>,
pub params: Box<RawValue>,
pub session: Option<String>,
pub auth_error: Option<StandardErrorBody>,
}
Expand description
Information about available authentication flows and status for User-Interactive Authenticiation API.
Fields (Non-exhaustive)§
This struct is marked as 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: 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§
Trait Implementations§
source§impl<'de> Deserialize<'de> for UiaaInfo
impl<'de> Deserialize<'de> for UiaaInfo
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for UiaaInfo
impl RefUnwindSafe for UiaaInfo
impl Send for UiaaInfo
impl Sync for UiaaInfo
impl Unpin for UiaaInfo
impl UnwindSafe for UiaaInfo
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)