Enum OAuth2Scope 

pub enum OAuth2Scope {
    OpenId,
    Email,
    Profile,
    OfflineAccess,
    Custom(String),
}

An OAuth 2.0 scope value.

Scopes are passed to crate::CliTokenClientBuilder::add_scopes to request specific permissions from the authorization server.

Example

use loopauth::OAuth2Scope;

// Display produces the wire-format string
assert_eq!(OAuth2Scope::OpenId.to_string(), "openid");
assert_eq!(OAuth2Scope::Custom("read:data".to_string()).to_string(), "read:data");

// Serde round-trip
let json = serde_json::to_string(&OAuth2Scope::OpenId).unwrap();
assert_eq!(json, r#""openid""#);
let roundtrip: OAuth2Scope = serde_json::from_str(&json).unwrap();
assert_eq!(roundtrip, OAuth2Scope::OpenId);

Variants

OpenId

The openid scope, required for OIDC ID token issuance.

Email

The email scope, requests the user’s email address claim.

Profile

The profile scope, requests basic profile claims (name, picture, etc.).

OfflineAccess

The offline_access scope, requests a refresh token.

Custom(String)

A custom or provider-specific scope value.

Trait Implementations

impl Clone for OAuth2Scope

fn clone(&self) -> OAuth2Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2Scope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuth2Scope

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OAuth2Scope

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

Formats the value using the given formatter.

impl From<&str> for OAuth2Scope

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<RequestScope> for OAuth2Scope

fn from(s: RequestScope) -> Self

Converts to this type from the input type.

impl FromStr for OAuth2Scope

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for OAuth2Scope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for OAuth2Scope

fn cmp(&self, other: &OAuth2Scope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OAuth2Scope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for OAuth2Scope

fn partial_cmp(&self, other: &OAuth2Scope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for OAuth2Scope

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OAuth2Scope

impl StructuralPartialEq for OAuth2Scope