Struct oxide_auth::endpoint::NormalizedParameter

pub struct NormalizedParameter { /* fields omitted */ }

The query parameter normal form.

When a request wants to give access to its query or body parameters by reference, it can do so by a reference of the particular trait. But when the representation of the query is not stored in the memory associated with the request, it needs to be allocated to outlive the borrow on the request. This allocation may as well perform the minimization/normalization into a representation actually consumed by the backend. This normal form thus encapsulates the associated clone-into-normal form by various possible constructors from references [WIP].

This gives rise to a custom Cow<QueryParameter> instance by requiring that normalization into memory with unrelated lifetime is always possible.

Internally a hashmap but this may change due to optimizations.

Methods

impl NormalizedParameter

pub fn new() -> Self

Create an empty map.

pub fn insert_or_poison(
    &mut self,
    key: Cow<'static, str>,
    val: Cow<'static, str>
)

Insert a key-value-pair or mark key as dead if already present.

Since each key must appear at most once, we do not remove it from the map but instead mark the key as having a duplicate entry.

Trait Implementations

impl QueryParameter for NormalizedParameter

fn unique_value(&self, key: &str) -> Option<Cow<str>>

Get the unique value associated with a key.

fn normalize(&self) -> NormalizedParameter

Guarantees that one can grab an owned copy.

impl Default for NormalizedParameter

fn default() -> NormalizedParameter

Returns the "default value" for a type.

impl Clone for NormalizedParameter

fn clone(&self) -> NormalizedParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizedParameter

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

Formats the value using the given formatter.

impl<K, V> FromIterator<(K, V)> for NormalizedParameter where
    K: Into<Cow<'static, str>>,
    V: Into<Cow<'static, str>>, 

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = (K, V)>, 

Creates a value from an iterator.

impl Borrow<dyn QueryParameter + 'static> for NormalizedParameter

fn borrow(&self) -> &(dyn QueryParameter + 'static)

Immutably borrows from an owned value.

impl<'de> Deserialize<'de> for NormalizedParameter

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

Deserialize this value from the given Serde deserializer.