#[non_exhaustive]
pub struct AuthorizationCode { pub authorization_url: String, pub token_url: String, pub refresh_url: Option<String>, pub scopes: Scopes, }
Expand description

Authorization code Flow configuration for OAuth2.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§authorization_url: String

Url for authorization token.

§token_url: String

Token url for the flow.

§refresh_url: Option<String>

Optional refresh token url for the flow.

§scopes: Scopes

Scopes required by the flow.

Implementations§

source§

impl AuthorizationCode

source

pub fn new<A: Into<String>, T: Into<String>>( authorization_url: A, token_url: T, scopes: Scopes ) -> Self

Construct a new authorization code oauth flow.

Accepts three arguments: one which is authorization url, two a token url and three a map of scopes for oauth flow.

Examples

Create new authorization code flow with scopes.

AuthorizationCode::new(
    "https://localhost/auth/dialog",
    "https://localhost/token",
    Scopes::from_iter([
        ("edit:items", "edit my items"),
        ("read:items", "read my items")
    ]),
);

Create new authorization code flow without any scopes.

AuthorizationCode::new(
    "https://localhost/auth/dialog",
    "https://localhost/token",
    Scopes::new(),
);
source

pub fn with_refresh_url<S: Into<String>>( authorization_url: S, token_url: S, scopes: Scopes, refresh_url: S ) -> Self

Construct a new AuthorizationCode OAuth2 flow with additional refresh token url.

This is essentially same as AuthorizationCode::new but allows defining extra parameter refresh_url for fetching refresh token.

Examples

Create AuthorizationCode OAuth2 flow with refresh url.

AuthorizationCode::with_refresh_url(
    "https://localhost/auth/dialog",
    "https://localhost/token",
    Scopes::new(),
    "https://localhost/refresh-token"
);

Trait Implementations§

source§

impl Clone for AuthorizationCode

source§

fn clone(&self) -> AuthorizationCode

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

impl<'de> Deserialize<'de> for AuthorizationCode

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq<AuthorizationCode> for AuthorizationCode

source§

fn eq(&self, other: &AuthorizationCode) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for AuthorizationCode

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for AuthorizationCode

source§

impl StructuralEq for AuthorizationCode

source§

impl StructuralPartialEq for AuthorizationCode

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere 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<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,