Struct actix_web_httpauth::extractors::bearer::BearerAuth

pub struct BearerAuth(_);

Extractor for HTTP Bearer auth

Example

use actix_web_httpauth::extractors::bearer::BearerAuth;

async fn index(auth: BearerAuth) -> String {
    format!("Hello, user with token {}!", auth.token())
}

If authentication fails, this extractor fetches the Config instance from the [app data] in order to properly form the WWW-Authenticate response header.

Example

use actix_web::{web, App};
use actix_web_httpauth::extractors::bearer::{BearerAuth, Config};

async fn index(auth: BearerAuth) -> String {
    format!("Hello, {}!", auth.token())
}

fn main() {
    let app = App::new()
        .data(
            Config::default()
                .realm("Restricted area")
                .scope("email photo"),
        )
        .service(web::resource("/index.html").route(web::get().to(index)));
}

Implementations

impl BearerAuth

pub fn token(&self) -> &str

Returns bearer token provided by client.

Trait Implementations

impl AuthExtractor for BearerAuth

type Future = Ready<Result<Self, Self::Error>>

Future that resolves into extracted credentials type.

type Error = AuthenticationError<Bearer>

The associated error which can be returned.

fn from_service_request(req: &ServiceRequest) -> Self::Future

Parse the authentication credentials from the actix’ ServiceRequest.

impl Clone for BearerAuth

fn clone(&self) -> BearerAuth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BearerAuth

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

Formats the value using the given formatter.

impl FromRequest for BearerAuth

type Config = Config

Configuration for this extractor.

type Future = Ready<Result<Self, Self::Error>>

Future that resolves to a Self.

type Error = AuthenticationError<Bearer>

The associated error which can be returned.

fn from_request(req: &HttpRequest, _payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

pub fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

pub fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.