# Struct actix_web_httpauth::extractors::AuthenticationError

source · [−]

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

Expand description

Authentication error returned by authentication extractors.

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

## Implementations

source

### impl AuthenticationError<Bearer>

Extended error customization for HTTP `Bearer` auth.

source

#### 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.

source

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

Attach error description to the current Authentication error.

source

#### 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.

source

### impl<C: Challenge> AuthenticationError<C>

source

#### 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.

source

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

Returns mutable reference to the inner challenge instance.

source

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

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

1.30.0 · source

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

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

source

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

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

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

1.0.0 · source

#### fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

Read more
1.0.0 · source

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

source

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

source

#### fn from(config: T) -> Self

Performs the conversion.

source

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

source

#### fn error_response(&self) -> HttpResponse

Creates full response for error. Read more

source

#### fn status_code(&self) -> StatusCode

Returns appropriate status code for error. Read more

## Auto Trait Implementations

### impl<C> RefUnwindSafe for AuthenticationError<C> where
C: RefUnwindSafe,

### impl<C> Send for AuthenticationError<C>

### impl<C> Sync for AuthenticationError<C>

### impl<C> Unpin for AuthenticationError<C> where
C: Unpin,

### impl<C> UnwindSafe for AuthenticationError<C> where
C: UnwindSafe,

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T> Instrument for T

source

#### fn instrument(self, span: Span) -> Instrumented<Self>

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

source

#### fn in_current_span(self) -> Instrumented<Self>

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

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> Same<T> for T

#### type Output = T

Should always be `Self`

source

### impl<T> ToString for T where
T: Display + ?Sized,

source

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

### impl<V, T> VZip<V> for T where
V: MultiLane<T>,

#### fn vzip(self) -> V

source

### impl<T> WithSubscriber for T

source

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

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

source

#### fn with_current_subscriber(self) -> WithDispatch<Self>

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