Struct BearerAuth

pub struct BearerAuth(/* private fields */);

Extractor for HTTP Bearer auth

Examples

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.

Examples

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

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

App::new()
    .app_data(
        bearer::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 Clone for BearerAuth

fn clone(&self) -> BearerAuth

Returns a copy of the value.

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 Future = Ready<Result<BearerAuth, <BearerAuth as FromRequest>::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 as FromRequest>::Future

Create a Self from request parts asynchronously.

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

Create a Self from request head asynchronously.