Struct aliri_oauth2::scope::ScopeToken

pub struct ScopeToken(/* private fields */);

An OAuth2 (or OIDC) scope token as defined in RFC 6749, Section 3.3

A scope token must be composed of printable ASCII characters excluding (space), " (double quote), and \ (backslash).

Implementations

impl ScopeToken

pub fn new(raw: CompactString) -> Result<Self, <ScopeToken as Validator>::Error>

Constructs a new ScopeToken if it conforms to ScopeToken

pub const unsafe fn new_unchecked(raw: CompactString) -> Self

Constructs a new ScopeToken without validation

Safety

Consumers of this function must ensure that values conform to ScopeToken. Failure to maintain this invariant may lead to undefined behavior.

pub fn from_static(raw: &'static str) -> Self

Constructs a new ScopeToken from a static reference if it conforms to ScopeToken

Panics

This function will panic if the provided raw string is not valid.

pub fn into_boxed_ref(self) -> Box<ScopeTokenRef>

Converts this ScopeToken into a Box<ScopeTokenRef>

This will drop any excess capacity.

pub fn take(self) -> CompactString

Unwraps the underlying [compact_str :: CompactString] value

impl ScopeToken

pub fn from_string(value: String) -> Result<Self, InvalidScopeToken>

Construct a new ScopeToken from a string

Errors

This function will return an error if the provided string is not a valid scope token.

pub const fn new_const(value: &str) -> Self

Construct a new ScopeToken from a string slice at compile time

Panics

If the provided scope token is not valid or is longer than 24 bytes, this function will panic or fail at compile time.

Methods from Deref<Target = ScopeTokenRef>

pub fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

Trait Implementations

impl AsRef<ScopeTokenRef> for ScopeToken

fn as_ref(&self) -> &ScopeTokenRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for ScopeToken

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<ScopeTokenRef> for ScopeToken

fn borrow(&self) -> &ScopeTokenRef

Immutably borrows from an owned value.

impl Borrow<str> for ScopeToken

fn borrow(&self) -> &str

Immutably borrows from an owned value.

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 Deref for ScopeToken

type Target = ScopeTokenRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ScopeToken

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

Deserialize this value from the given Serde deserializer.

impl Display for ScopeToken

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

Formats the value using the given formatter.

impl From<&ScopeTokenRef> for ScopeToken

fn from(s: &ScopeTokenRef) -> Self

Converts to this type from the input type.

impl From<Box<ScopeTokenRef>> for ScopeToken

fn from(r: Box<ScopeTokenRef>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, ScopeTokenRef>> for ScopeToken

fn from(r: Cow<'a, ScopeTokenRef>) -> Self

Converts to this type from the input type.

impl From<ScopeToken> for Box<ScopeTokenRef>

fn from(r: ScopeToken) -> Self

Converts to this type from the input type.

impl<'a> From<ScopeToken> for Cow<'a, ScopeTokenRef>

fn from(owned: ScopeToken) -> Self

Converts to this type from the input type.

impl From<ScopeToken> for Scope

fn from(t: ScopeToken) -> Self

Converts to this type from the input type.

impl From<ScopeToken> for String

fn from(s: ScopeToken) -> Self

Converts to this type from the input type.

impl FromStr for ScopeToken

type Err = <ScopeToken as Validator>::Error

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: &Self) -> 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<&ScopeTokenRef> for ScopeToken

fn eq(&self, other: &&ScopeTokenRef) -> 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 PartialEq<ScopeToken> for &ScopeTokenRef

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 PartialEq<ScopeToken> for ScopeTokenRef

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 PartialEq<ScopeTokenRef> for ScopeToken

fn eq(&self, other: &ScopeTokenRef) -> 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 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: &Self) -> 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 Serialize for ScopeToken

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ScopeToken

type Error = <ScopeToken as Validator>::Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for ScopeToken

type Error = <ScopeToken as Validator>::Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Validator for ScopeToken

fn validate(s: &str) -> Result<(), Self::Error>

Validates that the scope token is valid

A valid scope token is non-empty and composed of printable ASCII characters except , ", and \.

type Error = InvalidScopeToken

The error produced when the string is invalid

impl Eq for ScopeToken

impl StructuralPartialEq for ScopeToken