Claims

Struct Claims 

Source
pub struct Claims<T, E = BearerTokenExtractor> {
    pub claims: T,
    /* private fields */
}
Expand description

Axum extractor for validated JWT claims.

Extracts and validates JWT tokens from HTTP requests. The generic parameter T represents your claims type, and E specifies the token extraction strategy (defaults to BearerTokenExtractor).

§State Setup

Use Decoder<T> directly in your application state with FromRef:

use axum::extract::FromRef;
use axum_jwt_auth::{Decoder, LocalDecoder};
use std::sync::Arc;

#[derive(Clone, FromRef)]
struct AppState {
    decoder: Decoder<MyClaims>,
}

let decoder = LocalDecoder::builder()
    .keys(keys)
    .validation(validation)
    .build()
    .unwrap();

let state = AppState {
    decoder: Arc::new(decoder),
};

§Handler Examples

// Default: Extract from Authorization: Bearer <token>
async fn handler(user: Claims<MyClaims>) -> Json<MyClaims> {
    Json(user.claims)
}

// Extract from custom header
define_header_extractor!(XAuthToken, "x-auth-token");
async fn handler(user: Claims<MyClaims, HeaderTokenExtractor<XAuthToken>>) {
    // ...
}

// Extract from cookie
define_cookie_extractor!(AuthCookie, "auth_token");
async fn handler(user: Claims<MyClaims, CookieTokenExtractor<AuthCookie>>) {
    // ...
}

Fields§

§claims: T

The validated JWT claims payload

Trait Implementations§

Source§

impl<T: Debug, E: Debug> Debug for Claims<T, E>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S, T, E> FromRequestParts<S> for Claims<T, E>

Source§

type Rejection = AuthError

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

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

Auto Trait Implementations§

§

impl<T, E> Freeze for Claims<T, E>
where T: Freeze,

§

impl<T, E> RefUnwindSafe for Claims<T, E>

§

impl<T, E> Send for Claims<T, E>
where T: Send, E: Send,

§

impl<T, E> Sync for Claims<T, E>
where T: Sync, E: Sync,

§

impl<T, E> Unpin for Claims<T, E>
where T: Unpin, E: Unpin,

§

impl<T, E> UnwindSafe for Claims<T, E>
where T: UnwindSafe, E: 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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S, T> FromRequest<S, ViaParts> for T
where S: Send + Sync, T: FromRequestParts<S>,

Source§

type Rejection = <T as FromRequestParts<S>>::Rejection

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

fn from_request( req: Request<Body>, state: &S, ) -> impl Future<Output = Result<T, <T as FromRequest<S, ViaParts>>::Rejection>>

Perform the extraction.
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>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,