Skip to main content

SimpleOAuthClient

Struct SimpleOAuthClient 

Source
pub struct SimpleOAuthClient<P> { /* private fields */ }

Implementations§

Source§

impl<P> SimpleOAuthClient<P>

Source

pub async fn get_user_info( &self, access_token: &str, ) -> Result<UserInfo, SimpleOAuthError>

Retrieve user info from the provider using the access token. This is a convenience method for when you only need basic info (e.g. id, name, email, avatar).

Source

pub fn builder<'f1>() -> SimpleOAuthClientBuilder<'f1, P>

Source

pub fn authorize_url<'f1, 'f2, 'f3>( &'f1 self, ) -> SimpleOAuthClientAuthorizeUrlBuilder<'f1, 'f2, 'f3, P>

Build the URL to navigate the user to for authorization. Make sure to save the returned state and PKCE verifier in a secure location, typically in a server-side cache or session.

If scopes are not provided, will use default limited scopes for the provider to access basic user info (user ID and name only). If more access is needed (e.g. email), make sure to specify all required scopes.

You can optionally override the redirect URL, but make sure to pass in the exact same URL when calling exchange_code().

Source

pub fn exchange_code<'f1, 'f2, 'f3>( &'f1 self, ) -> SimpleOAuthClientExchangeCodeBuilder<'f1, 'f2, 'f3, P>

Exchange the returned code after authorization for an access/refresh token. Along with the returned code and state, you will need to specify the saved PKCE verifier and initial state (the state will be verified using a timing-resistant algorithm).

If you set the redirect URL when calling authorize_url(), you must set the same URL here as well.

Source

pub fn exchange_refresh_token<'f1>( &'f1 self, ) -> SimpleOAuthClientExchangeRefreshTokenBuilder<'f1, P>

Exchange the refresh token for a new access token

Trait Implementations§

Source§

impl<P: Clone> Clone for SimpleOAuthClient<P>

Source§

fn clone(&self) -> SimpleOAuthClient<P>

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<P: Debug> Debug for SimpleOAuthClient<P>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<P> !RefUnwindSafe for SimpleOAuthClient<P>

§

impl<P> !UnwindSafe for SimpleOAuthClient<P>

§

impl<P> Freeze for SimpleOAuthClient<P>
where P: Freeze,

§

impl<P> Send for SimpleOAuthClient<P>
where P: Send,

§

impl<P> Sync for SimpleOAuthClient<P>
where P: Sync,

§

impl<P> Unpin for SimpleOAuthClient<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for SimpleOAuthClient<P>
where P: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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