Struct HeaderRoleExtractor 

pub struct HeaderRoleExtractor { /* private fields */ }

Extract roles bitmask from an HTTP header.

The header value is parsed as a u32 bitmask directly, or you can use a custom parser function to convert header values to bitmasks.

Example

use axum_acl::HeaderRoleExtractor;

// Extract roles bitmask directly from X-Roles header (as decimal or hex)
let extractor = HeaderRoleExtractor::new("X-Roles");

// With a custom default roles bitmask for missing headers
let extractor = HeaderRoleExtractor::new("X-Roles")
    .with_default_roles(0b100);  // guest role

Implementations

impl HeaderRoleExtractor

pub fn new(header_name: impl Into<String>) -> Self

Create a new header role extractor.

pub fn with_default_roles(self, roles: u32) -> Self

Set default roles bitmask to use when the header is missing.

Trait Implementations

impl Clone for HeaderRoleExtractor

fn clone(&self) -> HeaderRoleExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderRoleExtractor

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

Formats the value using the given formatter.

impl<B> RoleExtractor<B> for HeaderRoleExtractor

fn extract_roles(&self, request: &Request<B>) -> RoleExtractionResult

Extract the roles bitmask from an HTTP request.