Skip to main content

AnyTokenProvider

Enum AnyTokenProvider 

Source
pub enum AnyTokenProvider {
    Static(StaticToken),
    Profile(ProfileTokenProvider),
    Azure(AzureTokenProvider),
    Gcp(GcpTokenProvider),
    AwsSts(AwsStsTokenProvider),
}
Expand description

Type-erased token provider.

Variants§

§

Static(StaticToken)

Static key, never refreshed.

§

Profile(ProfileTokenProvider)

Driven by a loaded [oauth] table.

§

Azure(AzureTokenProvider)

Azure AD client credentials.

§

Gcp(GcpTokenProvider)

GCP service-account JWT bearer.

§

AwsSts(AwsStsTokenProvider)

AWS STS AssumeRole (not a Bearer API key).

Implementations§

Source§

impl AnyTokenProvider

Source

pub fn without_http_refresh(&self)

Skip token-URL POSTs on later TokenProvider::get_token calls. No-op for static / cloud STS providers.

Source

pub fn quota_project_id(&self) -> Option<&str>

ADC quota_project_id for Vertex, if this is a GCP authorized_user grant.

Source

pub async fn offline_block(&self) -> Option<String>

Local reason TokenProvider::get_token would fail with no network.

None for static keys and for a profile token that is still inside its lifetime or that has a refresh token. Status uses this so it does not call the token URL.

Source

pub fn can_refresh(&self) -> bool

True when a 401 can be retried after TokenProvider::mark_stale and another get_token.

Static keys never refresh. AWS STS session keys are not a bearer token: get_token always fails, and mark_stale only affects get_credentials.

Trait Implementations§

Source§

impl Clone for AnyTokenProvider

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnyTokenProvider

Source§

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

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

impl From<AwsStsTokenProvider> for AnyTokenProvider

Available on crate feature net only.
Source§

fn from(t: AwsStsTokenProvider) -> Self

Converts to this type from the input type.
Source§

impl From<AzureTokenProvider> for AnyTokenProvider

Available on crate feature net only.
Source§

fn from(t: AzureTokenProvider) -> Self

Converts to this type from the input type.
Source§

impl From<GcpTokenProvider> for AnyTokenProvider

Available on crate feature net only.
Source§

fn from(t: GcpTokenProvider) -> Self

Converts to this type from the input type.
Source§

impl From<ProfileTokenProvider> for AnyTokenProvider

Available on crate feature net only.
Source§

fn from(t: ProfileTokenProvider) -> Self

Converts to this type from the input type.
Source§

impl From<StaticToken> for AnyTokenProvider

Available on crate feature net only.
Source§

fn from(t: StaticToken) -> Self

Converts to this type from the input type.
Source§

impl TokenProvider for AnyTokenProvider

Available on crate feature net only.
Source§

fn mark_stale(&self)

Drop the cached token so the next TokenProvider::get_token refreshes.
Source§

fn wake(&self)

Host laptop-wake hook. Default calls TokenProvider::mark_stale.
Source§

async fn get_token(&self) -> Result<String, AuthError>

Return a valid access token, refreshing if necessary.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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