Struct aliri_tokens::TokenWatcher

pub struct TokenWatcher { /* fields omitted */ }

A token watcher that can be uses to obtain up-to-date tokens

Implementations

impl TokenWatcher

pub async fn spawn_from_token_source<S, J>(
    token_source: S,
    jitter_source: J,
    backoff_config: ErrorBackoffConfig
) -> Result<Self, S::Error> where
    S: AsyncTokenSource + 'static,
    J: JitterSource + Send + 'static, 

Spawns a new token watcher which will automatically and periodically refresh the token from a token source

The token will be refreshed when it becomes stale. The token’s stale time will be jittered by jitter_source so that multiple instances don’t stampede at the same time.

This jittering also has the benefit of potentially allowing an update from one instance to be shared within a caching layer, thus preventing multiple requests to the ultimate token authority.

pub async fn spawn_from_token_source_with_clock<S, J, C>(
    token_source: S,
    jitter_source: J,
    backoff_config: ErrorBackoffConfig,
    clock: C
) -> Result<Self, S::Error> where
    S: AsyncTokenSource + 'static,
    J: JitterSource + Send + 'static,
    C: Clock + Send + 'static, 

Spawns a new token watcher using the given clock

pub async fn changed(&mut self) -> Result<(), TokenPublisherQuit>

A future that returns as ready whenever a new token is published

If the publisher is ever dropped, then this function will return an error indicating that no new tokens will be published.

pub fn token(&self) -> BorrowedToken<'_>

Borrows the current valid token

This borrow should be short-lived as outstanding borrows will block the publisher being able to report new tokens.

pub async fn watch<X: Fn(TokenWithLifetime) -> F, F: Future<Output = ()> + 'static>(
    self,
    sink: X
)

Runs a given asynchronous function whenever a new token update is provided

Loops forever so long as the publisher is still alive.

Trait Implementations

impl Clone for TokenWatcher

fn clone(&self) -> TokenWatcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenWatcher

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

Formats the value using the given formatter.