Struct oxide_auth::primitives::grant::Extensions

pub struct Extensions { /* fields omitted */ }

Links one or several GrantExtension instances to their respective data.

This also serves as a clean interface for both frontend and backend to reliably and conveniently manipulate or query the stored data sets.

Methods

impl Extensions

pub fn new() -> Extensions

Create a new extension store.

pub fn set(&mut self, extension: &dyn GrantExtension, content: Value)

Set the stored content for a GrantExtension instance.

pub fn set_raw(&mut self, identifier: String, content: Value)

Set content for an extension without a corresponding instance.

pub fn remove(&mut self, extension: &dyn GrantExtension) -> Option<Value>

Retrieve the stored data of an instance.

This removes the data from the store to avoid possible mixups and to allow a copyless retrieval of bigger data strings.

Important traits for PublicExtensions<'a>

impl<'a> Iterator for PublicExtensions<'a> type Item = (&'a str, Option<&'a str>);

pub fn iter_public(&self) -> PublicExtensions

Deprecated:

Use the simpler public instead.

Iterate of the public extensions whose presence and content is not secret.

Important traits for PublicExtensions<'a>

impl<'a> Iterator for PublicExtensions<'a> type Item = (&'a str, Option<&'a str>);

pub fn public(&self) -> PublicExtensions

Iterate of the public extensions whose presence and content is not secret.

Important traits for PublicExtensions<'a>

impl<'a> Iterator for PublicExtensions<'a> type Item = (&'a str, Option<&'a str>);

pub fn iter_private(&self) -> PublicExtensions

Deprecated:

The method return type is incorrect. Use the private method instead, or public if you actually intended to iterate public extensions.

Iterate of the private extensions whose presence and content must not be revealed.

Note: The return type is PublicExtensions by accident. This will be fixed in the next breaking release. The values yielded by the iterator are the private extensions, contrary to its name and short description.

Important traits for PrivateExtensions<'a>

impl<'a> Iterator for PrivateExtensions<'a> type Item = (&'a str, Option<&'a str>);

pub fn private(&self) -> PrivateExtensions

Iterate of the private extensions whose presence and content must not be revealed.

Trait Implementations

impl Default for Extensions

fn default() -> Extensions

Returns the "default value" for a type.

impl Clone for Extensions

fn clone(&self) -> Extensions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Extensions> for Extensions

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

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

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

This method tests for !=.

impl Eq for Extensions

impl Debug for Extensions

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

Formats the value using the given formatter.