Enum oxide_auth::primitives::grant::Value

pub enum Value {
    Public(Option<String>),
    Private(Option<String>),
}

Wraps the data for an extension as a string with access restrictions.

This is a generic way for extensions to store their data in a universal, encoded form. It is also able to indicate the intended readers for such an extension so that backends can ensure that private extension data is properly encrypted even when present in a self-encoded access token.

Some extensions have semantics where the presence alone is the stored data, so storing data is optional and storing no data is distinct from not attaching any extension instance at all.

Variants

Public(Option<String>)

An extension that the token owner is allowed to read and interpret.

Tuple Fields of Public

0: Option<String>

Private(Option<String>)

Identifies an extenion whose content and/or existance MUST be kept secret.

Tuple Fields of Private

0: Option<String>

Implementations

impl Value

pub fn public(content: Option<String>) -> Self

Creates an extension whose presence and content can be unveiled by the token holder.

Anyone in possession of the token corresponding to such a grant is potentially able to read the content of a public extension.

pub fn private(content: Option<String>) -> Value

Creates an extension with secret content only visible for the server.

Token issuers should take special care to protect the content and the identifier of such an extension from being interpreted or correlated by the token holder.

pub fn public_value(&self) -> Result<Option<&str>, ()>

Inspect the public value.

Returns an Err if this is not a public extension, None if the extension has no value but consists only of the key, and Some(_) otherwise.

pub fn into_public_value(self) -> Result<Option<String>, ()>

Convert into the public value.

Returns an Err if this is not a public extension, None if the extension has no value but consists only of the key, and Some(_) otherwise.

pub fn private_value(&self) -> Result<Option<&str>, ()>

Inspect the private value.

Returns an Err if this is not a private extension, None if the extension has no value but consists only of the key, and Some(_) otherwise.

pub fn into_private_value(self) -> Result<Option<String>, ()>

Inspect the private value.

Returns an Err if this is not a private extension, None if the extension has no value but consists only of the key, and Some(_) otherwise.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl PartialEq<Value> for Value

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

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

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

This method tests for !=.

impl Eq for Value

impl StructuralEq for Value

impl StructuralPartialEq for Value