Struct OAuthClientId 

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

An OAuth client’s public identifier: the client_id issued at dynamic client registration (RFC 7591) and carried on every authorization code, access token and refresh token the client obtains.

A string, not a UUID: registered clients get a UUID-shaped string, but the operator-token path (POST /api/auth/token) records the fixed sentinel OAuthClientId::OPERATOR_TOKEN ("m2m"), which is not a client at all. Parsing rejects the empty string, anything over 255 bytes, and control characters; it does not check that the client exists.

Implementations

impl OAuthClientId

pub const OPERATOR_TOKEN: &'static str = "m2m"

The client_id recorded on operator (machine-to-machine) tokens, which are issued from the operator’s own credentials rather than through an OAuth client.

pub fn operator_token() -> Self

The operator-token sentinel as an id.

pub fn is_operator_token(&self) -> bool

true for the operator-token sentinel.

pub fn generate() -> Self

A fresh id for a newly registered client.

pub fn as_str(&self) -> &str

The id as a string slice.

pub fn into_inner(self) -> String

Consume this id, yielding the inner String.

Trait Implementations

impl AsRef<str> for OAuthClientId

fn as_ref(&self) -> &str

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

impl Clone for OAuthClientId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthClientId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuthClientId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OAuthClientId

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

Formats the value using the given formatter.

impl Eq for OAuthClientId

impl From<OAuthClientId> for String

fn from(id: OAuthClientId) -> Self

Converts to this type from the input type.

impl FromStr for OAuthClientId

type Err = OAuthClientIdError

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 OAuthClientId

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 OAuthClientId

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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for OAuthClientId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OAuthClientId

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

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 OAuthClientId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OAuthClientId

impl TryFrom<String> for OAuthClientId

type Error = OAuthClientIdError

The type returned in the event of a conversion error.

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

Performs the conversion.