Skip to main content

TokenSourceCached

Struct TokenSourceCached 

Source
pub struct TokenSourceCached<S> { /* private fields */ }
Expand description

The return type of TokenSourceConfigurable::cached: wraps another token source and stores the last fetched credentials, serving them for repeat fetches with equal options for as long as they stay valid.

Credentials are kept in a TokenSourceStore (by default in memory, see TokenSourceCached::with_store) and are considered valid as long as a validator accepts them (by default until the token expires, see TokenSourceCached::with_validator).

Concurrent fetches that miss the cache are not deduplicated; each hits the underlying source and the last response wins.

Implementations§

Source§

impl<S> TokenSourceCached<S>

Source

pub fn with_store(self, store: impl TokenSourceStore + 'static) -> Self

Replaces the default in-memory store with a custom TokenSourceStore, e.g. one persisting credentials to the platform keychain or a database.

Source

pub fn with_validator<F>(self, validator: F) -> Self

Replaces the default validator deciding whether stored credentials are still valid or must be refetched. The default checks that the token has not expired (TokenSourceResponse::has_valid_token).

Pass the closure inline (or annotate its parameter types); binding it to a variable first can fail closure type inference.

Source

pub async fn invalidate(&self)

Removes the stored credentials, forcing the next fetch to hit the underlying source.

A fetch already in flight is unaffected: it still resolves and stores its response afterwards, repopulating the cache (last writer wins).

Source

pub async fn cached_response(&self) -> Option<TokenSourceResponse>

Returns the last stored response, if any — without checking its validity or which options it was fetched with, so it may be expired.

Trait Implementations§

Source§

impl<S: TokenSourceConfigurable + Send + Sync> TokenSourceConfigurable for TokenSourceCached<S>

Source§

fn fetch<'life0, 'life1, 'async_trait>( &'life0 self, options: &'life1 TokenSourceFetchOptions, ) -> Pin<Box<dyn Future<Output = TokenSourceResult<TokenSourceResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn cached(self) -> TokenSourceCached<Self>
where Self: Sized + Send + Sync,

Wraps this source in a caching layer that stores the last fetched credentials and serves them for repeat fetches with equal options, for as long as the token stays valid. See TokenSourceCached.

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for TokenSourceCached<S>

§

impl<S> !UnwindSafe for TokenSourceCached<S>

§

impl<S> Freeze for TokenSourceCached<S>
where S: Freeze,

§

impl<S> Send for TokenSourceCached<S>
where S: Send,

§

impl<S> Sync for TokenSourceCached<S>
where S: Sync,

§

impl<S> Unpin for TokenSourceCached<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for TokenSourceCached<S>
where S: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, <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