Struct yup_oauth2::authenticator::Authenticator

source · [−]

pub struct Authenticator<S> { /* private fields */ }

Expand description

Authenticator is responsible for fetching tokens, handling refreshing tokens, and optionally persisting tokens to disk.

Implementations

source

impl<S> Authenticator<S> where
 S: Service<Uri> + Clone + Send + Sync + 'static,
 S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
 S::Future: Send + Unpin + 'static,
 S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

pub async fn token<'a, T>(
 &'a self,
 scopes: &'a [T]
) -> Result<AccessToken, Error> where
 T: AsRef<str>,

Return the current token for the provided scopes.

source

pub async fn force_refreshed_token<'a, T>(
 &'a self,
 scopes: &'a [T]
) -> Result<AccessToken, Error> where
 T: AsRef<str>,

Return a token for the provided scopes, but don’t reuse cached tokens. Instead, always fetch a new token from the OAuth server.

source

pub async fn id_token<'a, T>(
 &'a self,
 scopes: &'a [T]
) -> Result<Option<String>, Error> where
 T: AsRef<str>,

Return the current ID token for the provided scopes, if any

Trait Implementations

source

impl<S: Clone> Clone for Authenticator<S>

source

fn clone(&self) -> Authenticator<S>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl<S> !RefUnwindSafe for Authenticator<S>

impl<S> Send for Authenticator<S> where
S: Send + Sync,

impl<S> Sync for Authenticator<S> where
S: Send + Sync,

impl<S> Unpin for Authenticator<S>

impl<S> !UnwindSafe for Authenticator<S>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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> ToOwned for T where
T: Clone,

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct yup_oauth2::authenticator::Authenticator

Implementations

impl<S> Authenticator<S> where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

pub async fn token<'a, T>( &'a self, scopes: &'a [T]) -> Result<AccessToken, Error> where T: AsRef<str>,

pub async fn force_refreshed_token<'a, T>( &'a self, scopes: &'a [T]) -> Result<AccessToken, Error> where T: AsRef<str>,

pub async fn id_token<'a, T>( &'a self, scopes: &'a [T]) -> Result<Option<String>, Error> where T: AsRef<str>,

Trait Implementations

impl<S: Clone> Clone for Authenticator<S>

fn clone(&self) -> Authenticator<S>

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

Auto Trait Implementations

impl<S> !RefUnwindSafe for Authenticator<S>

impl<S> Send for Authenticator<S> where S: Send + Sync,

impl<S> Sync for Authenticator<S> where S: Send + Sync,

impl<S> Unpin for Authenticator<S>

impl<S> !UnwindSafe for Authenticator<S>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<S> Authenticator<S> where
S: Service<Uri> + Clone + Send + Sync + 'static,
S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,

pub async fn token<'a, T>(
&'a self,
scopes: &'a [T]
) -> Result<AccessToken, Error> where
T: AsRef<str>,

pub async fn force_refreshed_token<'a, T>(
&'a self,
scopes: &'a [T]
) -> Result<AccessToken, Error> where
T: AsRef<str>,

pub async fn id_token<'a, T>(
&'a self,
scopes: &'a [T]
) -> Result<Option<String>, Error> where
T: AsRef<str>,

impl<S> Send for Authenticator<S> where
S: Send + Sync,

impl<S> Sync for Authenticator<S> where
S: Send + Sync,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,