Struct GoogleOAuth2Client

Source
pub struct GoogleOAuth2Client {
    pub client: Client<BasicErrorResponse, BasicTokenResponse, BasicTokenIntrospectionResponse, StandardRevocableToken, BasicRevocationErrorResponse, EndpointSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointSet>,
}
Expand description

A thin wrapper around oauth2 for Google OAuth2.

use tlns_google_oauth2::GoogleOAuth2Client;
 
#[pollster::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GoogleOAuth2Client::new(
        "client_id",
        "client_secret",
        "redirect_uri",
    )?;
    let auth_url = client.build_authorize_url(
        None,
        &[&tlns_google_oauth2::grouped_scopes::GoogleOAuth2APIv2::AuthUserinfoProfile, &tlns_google_oauth2::scopes::Scopes::AuthUserinfoEmail],
    );
    println!("Redirect to {}", auth_url.redirect_url);
 
    let token = client.get_token("code", None).await?;
    println!("Token: {:?}", token);
    Ok(())
}

Fields§

§client: Client<BasicErrorResponse, BasicTokenResponse, BasicTokenIntrospectionResponse, StandardRevocableToken, BasicRevocationErrorResponse, EndpointSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointSet>

OAuth2 client

Implementations§

Source§

impl GoogleOAuth2Client

Source

pub fn new( client_id: impl Into<String>, client_secret: impl Into<String>, redirect_uri: impl Into<String>, ) -> Result<Self, ParseError>

Create new crate::GoogleOAuth2Client instance

Source

pub fn build_authorize_url<'a>( &self, csrf_token: Option<fn() -> CsrfToken>, scopes: &'a [&'a dyn ToGoogleScope], ) -> Authentication<'a>

Make a authorization URL for user to authenticate csrf_token will be default oauth2::CsrfToken::new_random crate::grouped_scopes example will be

&[&tlns_google_oauth2::grouped_scopes::GoogleOAuth2APIv2::AuthUserinfoProfile];

Or like this!

use std::str::FromStr;
use tlns_google_oauth2::FromGoogleScope;
&[&tlns_google_oauth2::scopes::Scopes::from_google_scope("https://www.googleapis.com/auth/userinfo.profile").unwrap()];
// or
&[&tlns_google_oauth2::scopes::Scopes::from_str("https://www.googleapis.com/auth/userinfo.profile").unwrap()];

Or if you are using crate::scopes

&[&tlns_google_oauth2::scopes::Scopes::AuthUserinfoProfile];
Source

pub async fn get_token( &self, auth_code: impl Into<String>, http_client: Option<&Client>, ) -> Result<StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>, RequestTokenError<HttpClientError<Error>, StandardErrorResponse<BasicErrorResponseType>>>

Get authentication tokens from provider with authenticated code from Google Typically you will get it from the query string of the redirected URL

Source

pub async fn refresh_token( &self, refresh_token: impl Into<String>, http_client: Option<&Client>, ) -> Result<StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>, RequestTokenError<HttpClientError<Error>, StandardErrorResponse<BasicErrorResponseType>>>

Refresh your token in case it has expired You can retrieve it from oauth2::StandardTokenResponse::refresh_token

Trait Implementations§

Source§

impl Clone for GoogleOAuth2Client

Source§

fn clone(&self) -> GoogleOAuth2Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GoogleOAuth2Client

Source§

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

Formats the value using the given formatter. Read more

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> 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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T