Struct yup_oauth2::Authenticator

pub struct Authenticator<T: AuthFlow<C::Connector>, S: TokenStorage, AD: AuthenticatorDelegate, C: HyperClientBuilder> { /* fields omitted */ }

An authenticator can be used with InstalledFlow's or DeviceFlow's and will refresh tokens as they expire as well as optionally persist tokens to disk.

Methods

impl<T> Authenticator<T, MemoryStorage, DefaultAuthenticatorDelegate, DefaultHyperClient> where
    T: AuthFlow<<DefaultHyperClient as HyperClientBuilder>::Connector>, 

pub fn new(
    flow: T
) -> Authenticator<T, MemoryStorage, DefaultAuthenticatorDelegate, DefaultHyperClient>

Create a new authenticator with the provided flow. By default a new hyper::Client will be created the default authenticator delegate will be used, and tokens will not be persisted to disk. Accepted flow types are DeviceFlow and InstalledFlow.

Examples

use std::path::Path;
use yup_oauth2::{ApplicationSecret, Authenticator, DeviceFlow};
let creds = ApplicationSecret::default();
let auth = Authenticator::new(DeviceFlow::new(creds)).build().unwrap();

impl<T, S, AD, C> Authenticator<T, S, AD, C> where
    T: AuthFlow<C::Connector>,
    S: TokenStorage,
    AD: AuthenticatorDelegate,
    C: HyperClientBuilder, 

pub fn hyper_client<NewC>(
    self,
    hyper_client: Client<NewC>
) -> Authenticator<T, S, AD, Client<NewC>> where
    NewC: Connect,
    T: AuthFlow<NewC>, 

Use the provided hyper client.

pub fn persist_tokens_to_disk<P: AsRef<Path>>(
    self,
    path: P
) -> Authenticator<T, DiskTokenStorage, AD, C>

Persist tokens to disk in the provided filename.

pub fn delegate<NewAD: AuthenticatorDelegate>(
    self,
    delegate: NewAD
) -> Authenticator<T, S, NewAD, C>

Use the provided authenticator delegate.

pub fn build(self) -> Result<impl GetToken> where
    T::TokenGetter: 'static + GetToken + Send,
    S: 'static + Send,
    AD: 'static + Send,
    C::Connector: 'static + Clone + Send, 

Create the authenticator.