Struct actix_web_httpauth::headers::www_authenticate::bearer::Bearer

pub struct Bearer { /* fields omitted */ }

Challenge for WWW-Authenticate header with HTTP Bearer auth scheme, described in RFC 6750

Example

use actix_web_httpauth::headers::www_authenticate::bearer::{
    Bearer, Error,
};
use actix_web_httpauth::headers::www_authenticate::WwwAuthenticate;

fn index(_req: HttpRequest) -> HttpResponse {
    let challenge = Bearer::build()
        .realm("example")
        .scope("openid profile email")
        .error(Error::InvalidToken)
        .error_description("The access token expired")
        .error_uri("http://example.org")
        .finish();

    HttpResponse::Unauthorized()
        .set(WwwAuthenticate(challenge))
        .finish()
}

Methods

impl Bearer

pub fn build() -> BearerBuilder

Creates the builder for Bearer challenge.

Example

let challenge = Bearer::build()
    .realm("Restricted area")
    .scope("openid profile email")
    .finish();

Trait Implementations

impl AsRef<Bearer> for Config

fn as_ref(&self) -> &Bearer

Performs the conversion.

impl Clone for Bearer

fn clone(&self) -> Bearer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bearer

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

Formats the value using the given formatter.

impl Default for Bearer

fn default() -> Bearer

Returns the "default value" for a type.

impl Display for Bearer

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

Formats the value using the given formatter.

impl Eq for Bearer

impl Hash for Bearer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IntoHeaderValue for Bearer

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

fn try_into(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a Header value.

impl Ord for Bearer

fn cmp(&self, other: &Bearer) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Bearer> for Bearer

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

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

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

This method tests for !=.

impl PartialOrd<Bearer> for Bearer

fn partial_cmp(&self, other: &Bearer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Bearer) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Bearer) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Bearer) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Bearer) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Bearer

impl StructuralPartialEq for Bearer