Struct TokenExtractor 

pub struct TokenExtractor { /* private fields */ }

Extracts tokens from HTTP request parts according to configured sources.

Implementations

impl TokenExtractor

pub fn new(sources: Vec<TokenSourceKind>) -> Self

Create a new extractor with the given ordered sources.

pub fn bearer_only() -> Self

Bearer-only extractor.

pub fn with_source(self, src: TokenSourceKind) -> Self

Add a source.

pub fn sources(&self) -> &[TokenSourceKind]

Ordered sources.

pub fn extract_token(&self, parts: &Parts, query: &str) -> Option<String>

Available on crate feature axum only.

Extract the first token found according to source order.

When the axum feature is enabled the first argument is &http::request::Parts (from axum’s request). The second argument is the raw query string (e.g. "token=abc&foo=bar" without leading ?).

Returns None if no token was found in any source.

pub fn extract_from_parts( &self, auth_header: Option<&str>, cookie_header: Option<&str>, query: &str, ) -> Option<String>

Extract token without Parts (query and cookie header strings only).

Useful when axum is not enabled or for tests.

pub fn require_token( &self, parts: &Parts, query: &str, ) -> Result<String, WsAuthError>

Available on crate feature axum only.

Validate presence of token, returning a typed error.

Trait Implementations

impl Clone for TokenExtractor

fn clone(&self) -> TokenExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenExtractor

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

Formats the value using the given formatter.

impl Default for TokenExtractor

fn default() -> Self

Returns the “default value” for a type.