Skip to main content

CachedKeyStore

Struct CachedKeyStore 

Source
pub struct CachedKeyStore<C: KeyCache, S: KeyStore> { /* private fields */ }
Expand description

A caching wrapper for any KeyStore implementation.

This wrapper uses the cache-aside pattern: it first checks the cache for the key set, and only fetches from the underlying store on a cache miss. Retrieved key sets are then stored in the cache for future requests.

This is the recommended entry point for cached JWKS retrieval.

When looking up a key by ID, if the cached key set doesn’t contain the requested key, the store refetches from the underlying source. This handles key rotation gracefully: newly added keys are discovered automatically without waiting for cache expiration.

§Async and Send Bounds

On native targets, the KeyStore implementation for CachedKeyStore requires Send + Sync for both cache and source store for thread-safe usage. On wasm32, these bounds are relaxed to match the ?Send async model.

§Examples

use jwk_simple::jwks::{CachedKeyStore, HttpKeyStore, KeyStore, MokaKeyCache};
use std::time::Duration;

// Create a cached remote key store
let cache = MokaKeyCache::new(Duration::from_secs(300));
let remote = HttpKeyStore::new("https://example.com/.well-known/jwks.json")?;
let cached = CachedKeyStore::new(cache, remote);

// First call fetches from remote, caches the key set
let key = cached.get_key("kid").await?;

// Subsequent calls use the cache
let key = cached.get_key("kid").await?;

Implementations§

Source§

impl<C: KeyCache, S: KeyStore> CachedKeyStore<C, S>

Source

pub fn new(cache: C, store: S) -> Self

Creates a cache wrapper around the provided key store.

Source

pub fn cache(&self) -> &C

Returns the configured cache backend for inspection or cache management.

Source

pub fn store(&self) -> &S

Returns the underlying key store wrapped by this cache layer.

Trait Implementations§

Source§

impl<C: Debug + KeyCache, S: Debug + KeyStore> Debug for CachedKeyStore<C, S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<C, S> KeyStore for CachedKeyStore<C, S>
where C: KeyCache + Send + Sync, S: KeyStore + Send + Sync,

Source§

fn get_keyset<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<KeySet>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Gets all available keys as a KeySet. Read more
Source§

fn get_key<'life0, 'life1, 'async_trait>( &'life0 self, kid: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Key>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Gets a key by its key ID (kid). Read more

Auto Trait Implementations§

§

impl<C, S> Freeze for CachedKeyStore<C, S>
where C: Freeze, S: Freeze,

§

impl<C, S> RefUnwindSafe for CachedKeyStore<C, S>

§

impl<C, S> Send for CachedKeyStore<C, S>
where C: Send, S: Send,

§

impl<C, S> Sync for CachedKeyStore<C, S>
where C: Sync, S: Sync,

§

impl<C, S> Unpin for CachedKeyStore<C, S>
where C: Unpin, S: Unpin,

§

impl<C, S> UnsafeUnpin for CachedKeyStore<C, S>
where C: UnsafeUnpin, S: UnsafeUnpin,

§

impl<C, S> UnwindSafe for CachedKeyStore<C, S>
where C: UnwindSafe, S: UnwindSafe,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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, 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