Enum mas_oidc_client::types::scope::ScopeToken

pub enum ScopeToken {
    Openid,
    Profile,
    Email,
    Address,
    Phone,
    OfflineAccess,
    MatrixApi(MatrixApiScopeToken),
    MatrixDevice(PrivString),
    Custom(PrivString),
}

Tokens to define the scope of an access token or to request specific claims.

Variants

Openid

openid

Required for OpenID Connect requests.

Profile

profile

Requests access to the end-user’s profile.

Email

email

Requests access to the end-user’s email address.

Address

address

Requests access to the end-user’s address.

Phone

phone

Requests access to the end-user’s phone number.

OfflineAccess

offline_access

Requests that an OAuth 2.0 refresh token be issued that can be used to obtain an access token that grants access to the end-user’s UserInfo Endpoint even when the end-user is not present (not logged in).

MatrixApi(MatrixApiScopeToken)

urn:matrix:org.matrix.msc2967.client:api:{token}

Requests access to the Matrix Client-Server API.

MatrixDevice(PrivString)

urn:matrix:org.matrix.msc2967.client:device:{device_id}

Requests access to the Matrix device with the given device_id.

To access the device ID, use ScopeToken::matrix_device_id.

Custom(PrivString)

Another scope token.

To access it’s value use this type’s Display implementation.

Implementations

impl ScopeToken

pub fn try_with_matrix_device(device_id: String) -> Result<Self, InvalidScope>

Creates a Matrix device scope token with the given device ID.

Errors

Returns an error if the device ID string is not compatible with the scope syntax.

pub fn matrix_device_id(&self) -> Option<&str>

Get the device ID of this scope token, if it is a ScopeToken::MatrixDevice.

Trait Implementations

impl Clone for ScopeToken

fn clone(&self) -> ScopeToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeToken

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

Formats the value using the given formatter.

impl Display for ScopeToken

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

Formats the value using the given formatter.

impl From<ScopeToken> for ScopeToken

fn from(t: ScopeToken) -> Self

Converts to this type from the input type.

impl From<ScopeToken> for ScopeToken

fn from(t: StrScopeToken) -> Self

Converts to this type from the input type.

impl FromIterator<ScopeToken> for Scope

fn from_iter<T: IntoIterator<Item = ScopeToken>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for ScopeToken

type Err = InvalidScope

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 ScopeToken

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 ScopeToken

fn cmp(&self, other: &ScopeToken) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ScopeToken

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

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

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.

impl PartialOrd for ScopeToken

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for ScopeToken

impl StructuralPartialEq for ScopeToken