Struct TokenSource 

pub struct TokenSource { /* private fields */ }

A source of bearer tokens, consulted immediately before each authenticated request.

A source wraps an async closure, so any function can supply credentials. The providers in this crate convert into one with From. Clones share the closure.

Implementations

impl TokenSource

pub fn new<F, Fut>(token: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = CredentialResult<Option<Token>>> + Send + 'static,

A source that calls token before each request. token returns None when it has no credentials to offer.

pub fn fixed(token: Token) -> Self

A source that always returns token.

pub fn with_cached<F, Fut>(self, cached: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = CredentialResult<Option<Token>>> + Send + 'static,

Answer cached_token with cached, which must neither make network requests nor prompt.

pub async fn token(&self) -> CredentialResult<Option<Token>>

A usable token, or None when this source has no credentials to offer.

pub async fn cached_token(&self) -> CredentialResult<Option<Token>>

A token this source already holds, without network requests or prompts.

Trait Implementations

impl Clone for TokenSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenSource

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl From<ClientCredentialsProvider> for TokenSource

fn from(provider: ClientCredentialsProvider) -> Self

Converts to this type from the input type.

impl From<CredentialChain> for TokenSource

fn from(provider: CredentialChain) -> Self

Converts to this type from the input type.

impl From<FallbackAuthn> for TokenSource

fn from(provider: FallbackAuthn) -> Self

Converts to this type from the input type.

impl From<OidcAuthProvider> for TokenSource

fn from(provider: OidcAuthProvider) -> Self

Converts to this type from the input type.

impl From<RefreshingAuthTokenProvider> for TokenSource

fn from(provider: RefreshingAuthTokenProvider) -> Self

Converts to this type from the input type.

impl From<WorkloadAuthn> for TokenSource

fn from(provider: WorkloadAuthn) -> Self

Converts to this type from the input type.