Skip to main content

BearerAuthenticator

Enum BearerAuthenticator 

Source
pub enum BearerAuthenticator {
    Ephemeral {
        inner: EphemeralBearerAuthenticator,
    },
    Static {
        inner: StaticBearerAuthenticator,
    },
}
Expand description

A BearerAuthenticator (1) stores existing fresh auth tokens and (2) authenticates and fetches new auth tokens when they expire.

Variants§

§

Ephemeral

Fields

§inner: EphemeralBearerAuthenticator
§

Static

Fields

§inner: StaticBearerAuthenticator

Implementations§

Source§

impl BearerAuthenticator

Source

pub fn new( user_key_pair: KeyPair, maybe_token: Option<TokenWithExpiration>, ) -> Self

Create a new BearerAuthenticator with the auth api handle, the user_key_pair (for signing auth requests), and an optional existing token.

Source

pub fn new_with_scope( user_key_pair: KeyPair, maybe_token: Option<TokenWithExpiration>, scope: Option<Scope>, ) -> Self

BearerAuthenticator::new constructor with an optional scope to restrict requested auth tokens.

Source

pub fn new_static_token(token: BearerAuthToken) -> Self

A BearerAuthenticator that always returns the same static, long-lived token.

Source

pub fn user_key_pair(&self) -> Option<&KeyPair>

Source

pub async fn get_token<T: BearerAuthBackendApi + ?Sized>( &self, api: &T, now: SystemTime, ) -> Result<BearerAuthToken, BackendApiError>

Try to either (1) return an existing, fresh token or (2) authenticate with the backend to get a new fresh token (and cache it).

Source

pub async fn get_token_with_exp<T: BearerAuthBackendApi + ?Sized>( &self, api: &T, now: SystemTime, ) -> Result<TokenWithExpiration, BackendApiError>

Try to either (1) return an existing, fresh token or (2) authenticate with the backend to get a new fresh token (and cache it). Also returns the token’s expiration time.

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<F, T, U> Apply<F, U> for T
where F: FnOnce(T) -> U,

Source§

fn apply(self, f: F) -> U

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: 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: 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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