Struct AuthBearer

pub struct AuthBearer(pub String);

Bearer token extractor which contains the innards of a bearer header as a string

This is enabled via the auth-bearer feature

Example

This structure can be used like any other axum extractor:

use axum_auth::AuthBearer;

/// Handler for a typical [axum] route, takes a `token` and returns it
async fn handler(AuthBearer(token): AuthBearer) -> String {
    format!("Found a bearer token: {}", token)
}

Errors

There are a few errors which this extractor can make. By default, all invalid responses are 400 BAD REQUEST with one of these messages:

• `Authorization` header must be a bearer token – Somebody tried to but basic auth here instead of bearer
• `Authorization` header is missing – The header was required but it wasn’t found
• `Authorization` header contains invalid characters – The header couldn’t be processed because of invalid characters

Tuple Fields

0: String

Trait Implementations

impl AuthBearerCustom for AuthBearer

const ERROR_CODE: StatusCode = ERR_DEFAULT

Error code to use instead of the typical 400 BAD REQUEST error

const ERROR_OVERWRITE: Option<&'static str> = None

Message to overwrite all default ones with if required, leave as None ideally

fn from_header(contents: &str) -> Self

Converts provided header contents to new instance of self; you need to implement this

fn decode_request_parts(req: &mut Parts) -> Result<Self, Rejection>

Decodes bearer token content into new instance of self from axum body parts; this is automatically implemented

impl Clone for AuthBearer

fn clone(&self) -> AuthBearer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthBearer

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

Formats the value using the given formatter.

impl<B> FromRequestParts<B> for AuthBearer

where B: Send + Sync,

type Rejection = (StatusCode, &'static str)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( req: &mut Parts, _: &B, ) -> Result<Self, Self::Rejection>

Perform the extraction.

impl PartialEq for AuthBearer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AuthBearer

impl StructuralPartialEq for AuthBearer