Struct AuthState 

pub struct AuthState { /* private fields */ }

Available on non-WebAssembly and crate feature core only.

Helper struct to store authentication state in request extensions.

This struct is used by authentication middleware to communicate the authenticated user’s information to downstream handlers.

The struct contains a private field to prevent external construction via struct literal syntax. Use the provided constructors instead.

Security Note

If this state is serialized and sent to client-side code (e.g., in a WASM SPA), the permission checks (is_authenticated(), is_admin(), is_active()) should only be used for UI display purposes (showing/hiding elements). An attacker can modify client-side state, so all authorization decisions must be enforced server-side through authentication middleware and permission classes (see reinhardt-auth).

Example

// In middleware (after authentication)
request.extensions.insert(AuthState::authenticated("123", false, true));

// In handler (via CurrentUser or directly)
let auth_state: Option<AuthState> = request.extensions.get();

Implementations

impl AuthState

pub fn authenticated( user_id: impl Into<String>, is_admin: bool, is_active: bool, ) -> AuthState

Creates a new authenticated state.

Arguments

• user_id - The authenticated user’s ID
• is_admin - Whether the user has admin privileges
• is_active - Whether the user’s account is active

pub fn anonymous() -> AuthState

Creates an anonymous (unauthenticated) state.

pub fn from_extensions(extensions: &Extensions) -> Option<AuthState>

Create auth state from request extensions.

This method first attempts to retrieve an AuthState object that was inserted directly into extensions (e.g., by custom middleware). If no AuthState object is found, it falls back to reconstructing one from individual String (user_id) and bool (is_authenticated) entries stored in extensions by legacy middleware. Note that the fallback path sets is_admin and is_active to false since those values are not available as individual extension entries.

Returns

Returns Some(AuthState) if an AuthState object is found or if both user_id and is_authenticated individual entries exist, None otherwise.

pub fn user_id(&self) -> &str

Get the authenticated user’s ID.

pub fn is_authenticated(&self) -> bool

Check if the user is authenticated.

pub fn is_admin(&self) -> bool

Check if the user has admin privileges.

pub fn is_active(&self) -> bool

Check if the user’s account is active.

pub fn is_anonymous(&self) -> bool

Check if user is anonymous (not authenticated).

Trait Implementations

impl Clone for AuthState

fn clone(&self) -> AuthState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthState

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

Formats the value using the given formatter.

impl PartialEq for AuthState

fn eq(&self, other: &AuthState) -> 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 AuthState

impl StructuralPartialEq for AuthState