Struct oauth1_request::request::AssertSorted

pub struct AssertSorted<I> { /* private fields */ }

A wrapper type that implements Request with key-value pairs returned by the wrapped iterator.

The key-value pairs must be sorted as required by the Serializer trait. Otherwise, the behavior of this wrapper is unspecified.

Note that the required ordering is alphabetical ordering of AsRef<str> value of the key and Display representation of the value and does not necessarily match that of the one provided by the Ord trait, which may provide, for example, numerical ordering instead.

If you have a slice instead of an iterator, consider using ParameterList, which guarantees the correct ordering.

Example

use std::collections::BTreeMap;

let request = BTreeMap::from_iter([
   ("article_id", "123456789"),
   ("text", "A request signed with OAuth & Rust 🦀 🔏"),
]);
let request = oauth::request::AssertSorted::new(&request);

let form = oauth::to_form(&request);
assert_eq!(
   form,
   "article_id=123456789&text=A%20request%20signed%20with%20OAuth%20%26%20Rust%20%F0%9F%A6%80%20%F0%9F%94%8F",
);

Implementations

impl<I, K, V> AssertSorted<I> where
    I: Clone + Iterator<Item = (K, V)>,
    K: AsRef<str>,
    V: Display, 

pub fn new<J>(iterator: J) -> Self where
    J: IntoIterator<Item = (K, V), IntoIter = I>, 

Creates a new AssertSorted.

Trait Implementations

impl<I: Clone> Clone for AssertSorted<I>

fn clone(&self) -> AssertSorted<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for AssertSorted<I>

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

Formats the value using the given formatter.

impl<I: Default> Default for AssertSorted<I>

fn default() -> AssertSorted<I>

Returns the “default value” for a type.

impl<I, K, V> Request for AssertSorted<I> where
    I: Clone + Iterator<Item = (K, V)>,
    K: AsRef<str>,
    V: Display, 

fn serialize<S>(&self, serializer: S) -> S::Output where
    S: Serializer, 

Feeds a Serializer implementation with the key-value pairs of the request and returns the serializer’s output.

impl<I: Copy> Copy for AssertSorted<I>