Skip to main content

DocumentCache

Struct DocumentCache 

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

Generic JSON document cache shared by metadata and JWKS layers.

Implementations§

Source§

impl DocumentCache

Source

pub fn new( fetcher: DocumentFetcherFn, refresh_seconds: u64, document_type: impl Into<String>, on_change: Option<DocumentChangeCallback>, ) -> Arc<Self> ⓘ

Build a new cache with default error factory (transport_error).

Source

pub fn with_error_factory( fetcher: DocumentFetcherFn, refresh_seconds: u64, document_type: impl Into<String>, on_change: Option<DocumentChangeCallback>, error_factory: Box<dyn Fn(&str) -> AuthplaneError + Send + Sync>, ) -> Arc<Self> ⓘ

Build a cache with a custom error factory (e.g. JwksFetchError).

Source

pub fn document_type(&self) -> &str

Document type label.

Source

pub fn refresh_seconds(&self) -> u64

Configured refresh interval in seconds.

Source

pub async fn get(&self, force_refresh: bool) -> Result<Value, AuthplaneError>

Return the cached document, fetching or refreshing as needed.

Concurrent callers serialise behind an internal mutex so only one fetch is in flight at a time. On fetch errors a stale cache is served, silently — the crate carries no logging facility, so the failed refresh leaves no trace; if no cache existed yet, the error factory is invoked.

Source

pub async fn aclose(&self)

Cancel the background refresh task (if any). Safe to call multiple times.

Trait Implementations§

Source§

impl Debug for DocumentCache

Source§

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

Formats the value using the given formatter. 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> 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: Sized + 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: Sized + 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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