Enum AuthTokenState 

pub enum AuthTokenState {
    Valid {
        expires_in: Duration,
    },
    NearExpiry {
        expires_in: Duration,
    },
    Expired {
        expired_for: Duration,
    },
    Invalid,
}

Describes the observed state of the current auth token.

This type is intentionally framework agnostic. HTTP adapters and other delivery layers can translate transport-specific validation results into this domain-level model before invoking session renewal logic.

Variants

Valid

The auth token is currently valid and does not need renewal.

Fields

expires_in: Duration

Remaining time until the token expires.

NearExpiry

The auth token is still valid but has entered the proactive renewal window.

Fields

expires_in: Duration

Remaining time until the token expires.

Expired

The auth token has expired.

Fields

expired_for: Duration

Amount of time elapsed since expiry.

Invalid

The auth token is malformed, revoked, or otherwise invalid.

Implementations

impl AuthTokenState

pub fn is_currently_usable(self) -> bool

Returns true when the current token may still authorize the request.

pub fn should_attempt_proactive_renewal(self) -> bool

Returns true when the token has entered the proactive renewal window.

pub fn requires_renewal(self) -> bool

Returns true when successful renewal is required before a caller may continue.

pub fn is_invalid(self) -> bool

Returns true when the token must be rejected without renewal.

Trait Implementations

impl Clone for AuthTokenState

fn clone(&self) -> AuthTokenState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthTokenState

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

Formats the value using the given formatter.

impl Hash for AuthTokenState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AuthTokenState

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

impl Eq for AuthTokenState

impl StructuralPartialEq for AuthTokenState