Struct actix_web_httpauth::extractors::AuthenticationError

pub struct AuthenticationError<C: Challenge> { /* private fields */ }

Authentication error returned by authentication extractors.

Different extractors may extend AuthenticationError implementation in order to provide access to inner challenge fields.

Implementations

impl AuthenticationError<Bearer>

Extended error customization for HTTP Bearer auth.

pub fn with_error(self, kind: Error) -> Self

Attach Error to the current Authentication error.

Error status code will be changed to the one provided by the kind Error.

pub fn with_error_description<T>(self, desc: T) -> Self where
    T: Into<Cow<'static, str>>, 

Attach error description to the current Authentication error.

pub fn with_error_uri<T>(self, uri: T) -> Self where
    T: Into<Cow<'static, str>>, 

Attach error URI to the current Authentication error.

It is up to implementor to provide properly formed absolute URI.

impl<C: Challenge> AuthenticationError<C>

pub fn new(challenge: C) -> AuthenticationError<C>

Creates new authentication error from the provided challenge.

By default returned error will resolve into the HTTP 401 status code.

pub fn challenge_mut(&mut self) -> &mut C

Returns mutable reference to the inner challenge instance.

pub fn status_code_mut(&mut self) -> &mut StatusCode

Returns mutable reference to the inner status code.

Can be used to override returned status code, but by default this lib tries to stick to the RFC, so it might be unreasonable.

Trait Implementations

impl<C: Debug + Challenge> Debug for AuthenticationError<C>

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

Formats the value using the given formatter.

impl<C: Challenge> Display for AuthenticationError<C>

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

Formats the value using the given formatter.

impl<C: 'static + Challenge> Error for AuthenticationError<C>

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<T> From<T> for AuthenticationError<<T as AuthExtractorConfig>::Inner> where
    T: AuthExtractorConfig, 

fn from(config: T) -> Self

Performs the conversion.

impl<C: 'static + Challenge> ResponseError for AuthenticationError<C>

fn error_response(&self) -> HttpResponse

Creates full response for error.

fn status_code(&self) -> StatusCode

Returns appropriate status code for error.