Struct aliri_braid_examples::validated::ScopeToken

#[repr(transparent)]
pub struct ScopeToken(_);

A scope token as defined in RFC6749, Section 3.3

This type maintains an invariant that ensures that a value of this type cannot be constructed that contains invalid data.

The borrowed form of this type is generated by appending Ref to the end of the owned form: ScopeTokenRef.

Implementations

impl ScopeToken

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

Constructs a new ScopeToken if it conforms to ScopeToken

pub const unsafe fn new_unchecked(raw: String) -> 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) -> String

Unwraps the underlying String value

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, Global>> 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 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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

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 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 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 PartialOrd<ScopeToken> 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

type Error = InvalidScopeToken

The error produced when the string is invalid

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

Validates a string according to a predetermined set of rules

impl Eq for ScopeToken

impl StructuralEq for ScopeToken

impl StructuralPartialEq for ScopeToken