TokenCache

Struct TokenCache 

Source
pub struct TokenCache { /* private fields */ }
Expand description

Thread-safe cache for storing authentication tokens with expiration tracking.

Provides a simple key-value store for authentication tokens that automatically handles expiration checking and cleanup. The cache is designed to be shared across multiple threads and async tasks safely.

§Thread Safety

All operations are thread-safe and can be called concurrently from multiple async tasks. The cache uses RwLock for efficient concurrent read access.

§Examples

use quetty_server::auth::{TokenCache, CachedToken};
use std::time::{Duration, Instant};

let cache = TokenCache::new();

// Store a token
let token = CachedToken {
    token: "access_token_123".to_string(),
    expires_at: Instant::now() + Duration::from_secs(3600),
};
cache.set("user_123".to_string(), token).await;

// Retrieve a token (returns None if expired)
if let Some(token) = cache.get("user_123").await {
    println!("Token: {}", token);
}

Implementations§

Source§

impl TokenCache

Source

pub fn new() -> Self

Creates a new empty token cache.

§Returns

A new TokenCache instance ready for use

Source

pub async fn get(&self, key: &str) -> Option<String>

Retrieves a valid token from the cache.

Returns the token only if it exists and has not expired. Expired tokens are automatically filtered out.

§Arguments
  • key - The cache key to look up
§Returns

Some(token) if a valid token exists, None if no token exists or it has expired

Source

pub async fn set(&self, key: String, token: CachedToken)

Stores a token in the cache.

Overwrites any existing token with the same key.

§Arguments
  • key - The cache key to store the token under
  • token - The cached token with expiration information
Source

pub async fn invalidate(&self, key: &str)

Removes a specific token from the cache.

§Arguments
  • key - The cache key to remove
Source

pub async fn clear(&self)

Clears all tokens from the cache.

This is useful for logout operations or when switching authentication contexts.

Source

pub async fn needs_refresh(&self, key: &str) -> bool

Checks if a token needs refresh based on its expiration time.

Returns true if the token doesn’t exist, has expired, or is close to expiring.

§Arguments
  • key - The cache key to check
§Returns

true if the token needs refresh, false if it’s still valid

Trait Implementations§

Source§

impl Clone for TokenCache

Source§

fn clone(&self) -> TokenCache

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for TokenCache

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> SendBound for T
where T: Send,