Enum ruma::api::client::error::AuthenticateError

#[non_exhaustive]
pub enum AuthenticateError {
    InsufficientScope {
        scope: String,
    },
    // some variants omitted
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api and crate feature unstable-msc2967 only.

Errors in the WWW-Authenticate header.

To construct this use ::from_str(). To get its serialized form, use its TryInto<http::HeaderValue> implementation.

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.

InsufficientScope

Fields

scope: String

The new scope to request an authorization for.

insufficient_scope

Encountered when authentication is handled by OpenID Connect and the current access token isn’t authorized for the proper scope for this request. It should be paired with a 401 status code and a M_FORBIDDEN error.

Trait Implementations

impl Clone for AuthenticateError

fn clone(&self) -> AuthenticateError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticateError

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

Formats the value using the given formatter.

impl PartialEq<AuthenticateError> for AuthenticateError

fn eq(&self, other: &AuthenticateError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&AuthenticateError> for HeaderValue

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

fn try_from(
    error: &AuthenticateError
) -> Result<HeaderValue, <HeaderValue as TryFrom<&AuthenticateError>>::Error>

Performs the conversion.

impl Eq for AuthenticateError

impl StructuralEq for AuthenticateError

impl StructuralPartialEq for AuthenticateError