Struct querystring_tiny::QueryString

pub struct QueryString { /* private fields */ }

A query string

Warning

The query parser is pretty simple and basically parses any key or key= or key=value component without further validation.

The following rules apply:

• the query string MUST NOT begin with a ? – it’s not a bug, it’s a feature: this allows the parser to parse raw query strings in the body (e.g. from HTML forms)
• keys don’t need a value (i.e. key0&key1 is valid)
• keys can have an empty value (i.e. key0=&key1= is valid)
• keys can have a non-empty value (i.e. key0=value0&key1=value1 is valid)
• empty keys/key-value pairs are ignored (i.e. & evaluates to [], key0&&key1 evaluates to ["key0": "", "key1": ""] and =value0&key1=value1& evaluates to ["key1": "value1"])

Implementations

impl QueryString

pub fn new() -> Self

Creates a new header field map

pub fn decode(source: &[u8]) -> Result<Self, Error>

Decodes a query string

pub fn get<T>(&self, name: T) -> Option<&[u8]> where
    T: AsRef<[u8]>, 

Gets the value for the field with the given name

pub fn set<A, B>(&mut self, name: A, value: B) where
    A: Into<Vec<u8>>,
    B: Into<Vec<u8>>, 

Sets the value for a fiels with the given name

pub fn encode(&self) -> Vec<u8>

Encodes the query string

Methods from Deref<Target = BTreeMap<Vec<u8>, Vec<u8>>>

pub fn get<Q>(&self, key: &Q) -> Option<&V> where
    K: Borrow<Q> + Ord,
    Q: Ord + ?Sized, 

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);

pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)> where
    K: Borrow<Q> + Ord,
    Q: Ord + ?Sized, 

Returns the key-value pair corresponding to the supplied key.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
assert_eq!(map.get_key_value(&2), None);

pub fn first_key_value(&self) -> Option<(&K, &V)> where
    K: Ord, 

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

Returns the first key-value pair in the map. The key in this pair is the minimum key in the map.

Examples

Basic usage:

#![feature(map_first_last)]
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
assert_eq!(map.first_key_value(), None);
map.insert(1, "b");
map.insert(2, "a");
assert_eq!(map.first_key_value(), Some((&1, &"b")));

pub fn last_key_value(&self) -> Option<(&K, &V)> where
    K: Ord, 

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

Returns the last key-value pair in the map. The key in this pair is the maximum key in the map.

Examples

Basic usage:

#![feature(map_first_last)]
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "b");
map.insert(2, "a");
assert_eq!(map.last_key_value(), Some((&2, &"a")));

pub fn contains_key<Q>(&self, key: &Q) -> bool where
    K: Borrow<Q> + Ord,
    Q: Ord + ?Sized, 

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);

pub fn range<T, R>(&self, range: R) -> Range<'_, K, V> where
    T: Ord + ?Sized,
    K: Borrow<T> + Ord,
    R: RangeBounds<T>, 

Constructs a double-ended iterator over a sub-range of elements in the map. The simplest way is to use the range syntax min..max, thus range(min..max) will yield elements from min (inclusive) to max (exclusive). The range may also be entered as (Bound<T>, Bound<T>), so for example range((Excluded(4), Included(10))) will yield a left-exclusive, right-inclusive range from 4 to 10.

Panics

Panics if range start > end. Panics if range start == end and both bounds are Excluded.

Examples

Basic usage:

use std::collections::BTreeMap;
use std::ops::Bound::Included;

let mut map = BTreeMap::new();
map.insert(3, "a");
map.insert(5, "b");
map.insert(8, "c");
for (&key, &value) in map.range((Included(&4), Included(&8))) {
    println!("{key}: {value}");
}
assert_eq!(Some((&5, &"b")), map.range(4..).next());

pub fn iter(&self) -> Iter<'_, K, V>

Gets an iterator over the entries of the map, sorted by key.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(3, "c");
map.insert(2, "b");
map.insert(1, "a");

for (key, value) in map.iter() {
    println!("{key}: {value}");
}

let (first_key, first_value) = map.iter().next().unwrap();
assert_eq!((*first_key, *first_value), (1, "a"));

pub fn keys(&self) -> Keys<'_, K, V>

Gets an iterator over the keys of the map, in sorted order.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(2, "b");
a.insert(1, "a");

let keys: Vec<_> = a.keys().cloned().collect();
assert_eq!(keys, [1, 2]);

pub fn values(&self) -> Values<'_, K, V>

Gets an iterator over the values of the map, in order by key.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(1, "hello");
a.insert(2, "goodbye");

let values: Vec<&str> = a.values().cloned().collect();
assert_eq!(values, ["hello", "goodbye"]);

pub fn len(&self) -> usize

Returns the number of elements in the map.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
assert_eq!(a.len(), 0);
a.insert(1, "a");
assert_eq!(a.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Examples

Basic usage:

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
assert!(a.is_empty());
a.insert(1, "a");
assert!(!a.is_empty());

Trait Implementations

impl Clone for QueryString

fn clone(&self) -> QueryString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryString

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

Formats the value using the given formatter.

impl Default for QueryString

fn default() -> QueryString

Returns the “default value” for a type.

impl Deref for QueryString

type Target = BTreeMap<Vec<u8, Global>, Vec<u8, Global>, Global>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<K, V> FromIterator<(K, V)> for QueryString where
    K: Into<Vec<u8>>,
    V: Into<Vec<u8>>, 

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

Creates a value from an iterator.

impl IntoIterator for QueryString

type Item = <BTreeMap<Vec<u8, Global>, Vec<u8, Global>, Global> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <BTreeMap<Vec<u8, Global>, Vec<u8, Global>, Global> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.