use std::collections::HashMap; use std::collections::hash_map::RandomState; use std::convert::TryFrom; use std::hash::{BuildHasher, Hash, Hasher}; use std::iter::{FromIterator, FusedIterator}; use std::marker::PhantomData; use std::{fmt, mem, ops, ptr, vec};
/// A set of HTTP headers /// /// `HeaderMap` is an multimap of [`HeaderName`] to values. /// /// [`HeaderName`]: struct.HeaderName.html /// /// # Examples /// /// Basic usage /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST, LOCATION}; /// let mut headers = HeaderMap::new(); /// /// headers.insert(HOST, "example.com".parse().unwrap()); /// headers.insert(CONTENT_LENGTH, "123".parse().unwrap()); /// /// assert!(headers.contains_key(HOST)); /// assert!(!headers.contains_key(LOCATION)); /// /// assert_eq!(headers[HOST], "example.com"); /// /// headers.remove(HOST); /// /// assert!(!headers.contains_key(HOST)); /// ``` #[derive(Clone)] pubstruct HeaderMap<T = HeaderValue> { // Used to mask values to get an index
mask: Size,
indices: Box<[Pos]>,
entries: Vec<Bucket<T>>,
extra_values: Vec<ExtraValue<T>>,
danger: Danger,
}
// # Implementation notes // // Below, you will find a fairly large amount of code. Most of this is to // provide the necessary functions to efficiently manipulate the header // multimap. The core hashing table is based on robin hood hashing [1]. While // this is the same hashing algorithm used as part of Rust's `HashMap` in // stdlib, many implementation details are different. The two primary reasons // for this divergence are that `HeaderMap` is a multimap and the structure has // been optimized to take advantage of the characteristics of HTTP headers. // // ## Structure Layout // // Most of the data contained by `HeaderMap` is *not* stored in the hash table. // Instead, pairs of header name and *first* associated header value are stored // in the `entries` vector. If the header name has more than one associated // header value, then additional values are stored in `extra_values`. The actual // hash table (`indices`) only maps hash codes to indices in `entries`. This // means that, when an eviction happens, the actual header name and value stay // put and only a tiny amount of memory has to be copied. // // Extra values associated with a header name are tracked using a linked list. // Links are formed with offsets into `extra_values` and not pointers. // // [1]: https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing
/// `HeaderMap` entry iterator. /// /// Yields `(&HeaderName, &value)` tuples. The same header name may be yielded /// more than once if it has more than one associated value. #[derive(Debug)] pubstruct Iter<'a, T> {
inner: IterMut<'a, T>,
}
/// `HeaderMap` mutable entry iterator /// /// Yields `(&HeaderName, &mut value)` tuples. The same header name may be /// yielded more than once if it has more than one associated value. #[derive(Debug)] pubstruct IterMut<'a, T> {
map: *mut HeaderMap<T>,
entry: usize,
cursor: Option<Cursor>,
lt: PhantomData<&'a mut HeaderMap<T>>,
}
/// An owning iterator over the entries of a `HeaderMap`. /// /// This struct is created by the `into_iter` method on `HeaderMap`. #[derive(Debug)] pubstruct IntoIter<T> { // If None, pull from `entries`
next: Option<usize>,
entries: vec::IntoIter<Bucket<T>>,
extra_values: Vec<ExtraValue<T>>,
}
/// An iterator over `HeaderMap` keys. /// /// Each header name is yielded only once, even if it has more than one /// associated value. #[derive(Debug)] pubstruct Keys<'a, T> {
inner: ::std::slice::Iter<'a, Bucket<T>>,
}
/// `HeaderMap` value iterator. /// /// Each value contained in the `HeaderMap` will be yielded. #[derive(Debug)] pubstruct Values<'a, T> {
inner: Iter<'a, T>,
}
/// A drain iterator for `HeaderMap`. #[derive(Debug)] pubstruct Drain<'a, T> {
idx: usize,
len: usize,
entries: *mut [Bucket<T>], // If None, pull from `entries`
next: Option<usize>,
extra_values: *mut Vec<ExtraValue<T>>,
lt: PhantomData<&'a mut HeaderMap<T>>,
}
/// A view to all values stored in a single entry. /// /// This struct is returned by `HeaderMap::get_all`. #[derive(Debug)] pubstruct GetAll<'a, T> {
map: &'a HeaderMap<T>,
index: Option<usize>,
}
/// A view into a single location in a `HeaderMap`, which may be vacant or occupied. #[derive(Debug)] pubenum Entry<'a, T: 'a> { /// An occupied entry
Occupied(OccupiedEntry<'a, T>),
/// A vacant entry
Vacant(VacantEntry<'a, T>),
}
/// A view into a single empty location in a `HeaderMap`. /// /// This struct is returned as part of the `Entry` enum. #[derive(Debug)] pubstruct VacantEntry<'a, T> {
map: &'a mut HeaderMap<T>,
key: HeaderName,
hash: HashValue,
probe: usize,
danger: bool,
}
/// A view into a single occupied location in a `HeaderMap`. /// /// This struct is returned as part of the `Entry` enum. #[derive(Debug)] pubstruct OccupiedEntry<'a, T> {
map: &'a mut HeaderMap<T>,
probe: usize,
index: usize,
}
/// An iterator of all values associated with a single header name. #[derive(Debug)] pubstruct ValueIter<'a, T> {
map: &'a HeaderMap<T>,
index: usize,
front: Option<Cursor>,
back: Option<Cursor>,
}
/// A mutable iterator of all values associated with a single header name. #[derive(Debug)] pubstruct ValueIterMut<'a, T> {
map: *mut HeaderMap<T>,
index: usize,
front: Option<Cursor>,
back: Option<Cursor>,
lt: PhantomData<&'a mut HeaderMap<T>>,
}
/// An drain iterator of all values associated with a single header name. #[derive(Debug)] pubstruct ValueDrain<'a, T> {
first: Option<T>,
next: Option<::std::vec::IntoIter<T>>,
lt: PhantomData<&'a mut HeaderMap<T>>,
}
/// Tracks the value iterator state #[derive(Debug, Copy, Clone, Eq, PartialEq)] enum Cursor {
Head,
Values(usize),
}
/// Type used for representing the size of a HeaderMap value. /// /// 32,768 is more than enough entries for a single header map. Setting this /// limit enables using `u16` to represent all offsets, which takes 2 bytes /// instead of 8 on 64 bit processors. /// /// Setting this limit is especially benificial for `indices`, making it more /// cache friendly. More hash codes can fit in a cache line. /// /// You may notice that `u16` may represent more than 32,768 values. This is /// true, but 32,768 should be plenty and it allows us to reserve the top bit /// for future usage. type Size = u16;
/// This limit falls out from above. const MAX_SIZE: usize = 1 << 15;
/// An entry in the hash table. This represents the full hash code for an entry /// as well as the position of the entry in the `entries` vector. #[derive(Copy, Clone)] struct Pos { // Index in the `entries` vec
index: Size, // Full hash value for the entry.
hash: HashValue,
}
/// Hash values are limited to u16 as well. While `fast_hash` and `Hasher` /// return `usize` hash codes, limiting the effective hash code to the lower 16 /// bits is fine since we know that the `indices` vector will never grow beyond /// that size. #[derive(Debug, Copy, Clone, Eq, PartialEq)] struct HashValue(u16);
/// Stores the data associated with a `HeaderMap` entry. Only the first value is /// included in this struct. If a header name has more than one associated /// value, all extra values are stored in the `extra_values` vector. A doubly /// linked list of entries is maintained. The doubly linked list is used so that /// removing a value is constant time. This also has the nice property of /// enabling double ended iteration. #[derive(Debug, Clone)] struct Bucket<T> {
hash: HashValue,
key: HeaderName,
value: T,
links: Option<Links>,
}
/// The head and tail of the value linked list. #[derive(Debug, Copy, Clone)] struct Links {
next: usize,
tail: usize,
}
/// Access to the `links` value in a slice of buckets. /// /// It's important that no other field is accessed, since it may have been /// freed in a `Drain` iterator. #[derive(Debug)] struct RawLinks<T>(*mut [Bucket<T>]);
/// Node in doubly-linked list of header value entries #[derive(Debug, Clone)] struct ExtraValue<T> {
value: T,
prev: Link,
next: Link,
}
/// A header value node is either linked to another node in the `extra_values` /// list or it points to an entry in `entries`. The entry in `entries` is the /// start of the list and holds the associated header name. #[derive(Debug, Copy, Clone, Eq, PartialEq)] enum Link {
Entry(usize),
Extra(usize),
}
/// Tracks the header map danger level! This relates to the adaptive hashing /// algorithm. A HeaderMap starts in the "green" state, when a large number of /// collisions are detected, it transitions to the yellow state. At this point, /// the header map will either grow and switch back to the green state OR it /// will transition to the red state. /// /// When in the red state, a safe hashing algorithm is used and all values in /// the header map have to be rehashed. #[derive(Clone)] enum Danger {
Green,
Yellow,
Red(RandomState),
}
// Constants related to detecting DOS attacks. // // Displacement is the number of entries that get shifted when inserting a new // value. Forward shift is how far the entry gets stored from the ideal // position. // // The current constant values were picked from another implementation. It could // be that there are different values better suited to the header map case. const DISPLACEMENT_THRESHOLD: usize = 128; const FORWARD_SHIFT_THRESHOLD: usize = 512;
// The default strategy for handling the yellow danger state is to increase the // header map capacity in order to (hopefully) reduce the number of collisions. // If growing the hash map would cause the load factor to drop bellow this // threshold, then instead of growing, the headermap is switched to the red // danger state and safe hashing is used instead. const LOAD_FACTOR_THRESHOLD: f32 = 0.2;
// Macro used to iterate the hash table starting at a given point, looping when // the end is hit.
macro_rules! probe_loop {
($label:tt: $probe_var: ident < $len: expr, $body: expr) => {
debug_assert!($len > 0);
$label: loop { if $probe_var < $len {
$body
$probe_var += 1;
} else {
$probe_var = 0;
}
}
};
($probe_var: ident < $len: expr, $body: expr) => {
debug_assert!($len > 0); loop { if $probe_var < $len {
$body
$probe_var += 1;
} else {
$probe_var = 0;
}
}
};
}
// First part of the robinhood algorithm. Given a key, find the slot in which it // will be inserted. This is done by starting at the "ideal" spot. Then scanning // until the destination slot is found. A destination slot is either the next // empty slot or the next slot that is occupied by an entry that has a lower // displacement (displacement is the distance from the ideal spot). // // This is implemented as a macro instead of a function that takes a closure in // order to guarantee that it is "inlined". There is no way to annotate closures // to guarantee inlining.
macro_rules! insert_phase_one {
($map:ident,
$key:expr,
$probe:ident,
$pos:ident,
$hash:ident,
$danger:ident,
$vacant:expr,
$occupied:expr,
$robinhood:expr) =>
{{ let $hash = hash_elem_using(&$map.danger, &$key); letmut $probe = desired_pos($map.mask, $hash); letmut dist = 0; let ret;
// Start at the ideal position, checking all slots
probe_loop!('probe: $probe < $map.indices.len(), { iflet Some(($pos, entry_hash)) = $map.indices[$probe].resolve() { // The slot is already occupied, but check if it has a lower // displacement. let their_dist = probe_distance($map.mask, entry_hash, $probe);
if their_dist < dist { // The new key's distance is larger, so claim this spot and // displace the current entry. // // Check if this insertion is above the danger threshold. let $danger =
dist >= FORWARD_SHIFT_THRESHOLD && !$map.danger.is_red();
ret = $robinhood; break'probe;
} elseif entry_hash == $hash && $map.entries[$pos].key == $key { // There already is an entry with the same key.
ret = $occupied; break'probe;
}
} else { // The entry is vacant, use it for this key. let $danger =
dist >= FORWARD_SHIFT_THRESHOLD && !$map.danger.is_red();
ret = $vacant; break'probe;
}
dist += 1;
});
ret
}}
}
// ===== impl HeaderMap =====
impl HeaderMap { /// Create an empty `HeaderMap`. /// /// The map will be created without any capacity. This function will not /// allocate. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// let map = HeaderMap::new(); /// /// assert!(map.is_empty()); /// assert_eq!(0, map.capacity()); /// ``` pubfn new() -> Self {
HeaderMap::with_capacity(0)
}
}
impl<T> HeaderMap<T> { /// Create an empty `HeaderMap` with the specified capacity. /// /// The returned map will allocate internal storage in order to hold about /// `capacity` elements without reallocating. However, this is a "best /// effort" as there are usage patterns that could cause additional /// allocations before `capacity` headers are stored in the map. /// /// More capacity than requested may be allocated. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// let map: HeaderMap<u32> = HeaderMap::with_capacity(10); /// /// assert!(map.is_empty()); /// assert_eq!(12, map.capacity()); /// ``` pubfn with_capacity(capacity: usize) -> HeaderMap<T> { if capacity == 0 {
HeaderMap {
mask: 0,
indices: Box::new([]), // as a ZST, this doesn't actually allocate anything
entries: Vec::new(),
extra_values: Vec::new(),
danger: Danger::Green,
}
} else { let raw_cap = to_raw_capacity(capacity).next_power_of_two();
assert!(raw_cap <= MAX_SIZE, "requested capacity too large");
debug_assert!(raw_cap > 0);
/// Returns the number of headers stored in the map. /// /// This number represents the total number of **values** stored in the map. /// This number can be greater than or equal to the number of **keys** /// stored given that a single key may have more than one associated value. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{ACCEPT, HOST}; /// let mut map = HeaderMap::new(); /// /// assert_eq!(0, map.len()); /// /// map.insert(ACCEPT, "text/plain".parse().unwrap()); /// map.insert(HOST, "localhost".parse().unwrap()); /// /// assert_eq!(2, map.len()); /// /// map.append(ACCEPT, "text/html".parse().unwrap()); /// /// assert_eq!(3, map.len()); /// ``` pubfn len(&self) -> usize { self.entries.len() + self.extra_values.len()
}
/// Returns the number of keys stored in the map. /// /// This number will be less than or equal to `len()` as each key may have /// more than one associated value. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{ACCEPT, HOST}; /// let mut map = HeaderMap::new(); /// /// assert_eq!(0, map.keys_len()); /// /// map.insert(ACCEPT, "text/plain".parse().unwrap()); /// map.insert(HOST, "localhost".parse().unwrap()); /// /// assert_eq!(2, map.keys_len()); /// /// map.insert(ACCEPT, "text/html".parse().unwrap()); /// /// assert_eq!(2, map.keys_len()); /// ``` pubfn keys_len(&self) -> usize { self.entries.len()
}
/// Returns true if the map contains no elements. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// /// assert!(map.is_empty()); /// /// map.insert(HOST, "hello.world".parse().unwrap()); /// /// assert!(!map.is_empty()); /// ``` pubfn is_empty(&self) -> bool { self.entries.len() == 0
}
/// Clears the map, removing all key-value pairs. Keeps the allocated memory /// for reuse. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "hello.world".parse().unwrap()); /// /// map.clear(); /// assert!(map.is_empty()); /// assert!(map.capacity() > 0); /// ``` pubfn clear(&mutself) { self.entries.clear(); self.extra_values.clear(); self.danger = Danger::Green;
for e inself.indices.iter_mut() {
*e = Pos::none();
}
}
/// Returns the number of headers the map can hold without reallocating. /// /// This number is an approximation as certain usage patterns could cause /// additional allocations before the returned capacity is filled. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// /// assert_eq!(0, map.capacity()); /// /// map.insert(HOST, "hello.world".parse().unwrap()); /// assert_eq!(6, map.capacity()); /// ``` pubfn capacity(&self) -> usize {
usable_capacity(self.indices.len())
}
/// Reserves capacity for at least `additional` more headers to be inserted /// into the `HeaderMap`. /// /// The header map may reserve more space to avoid frequent reallocations. /// Like with `with_capacity`, this will be a "best effort" to avoid /// allocations until `additional` more headers are inserted. Certain usage /// patterns could cause additional allocations before the number is /// reached. /// /// # Panics /// /// Panics if the new allocation size overflows `usize`. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// map.reserve(10); /// # map.insert(HOST, "bar".parse().unwrap()); /// ``` pubfn reserve(&mutself, additional: usize) { // TODO: This can't overflow if done properly... since the max # of // elements is u16::MAX. let cap = self
.entries
.len()
.checked_add(additional)
.expect("reserve overflow");
if cap > self.indices.len() { let cap = cap.next_power_of_two();
assert!(cap <= MAX_SIZE, "header map reserve over max capacity");
assert!(cap != 0, "header map reserve overflowed");
/// Returns a reference to the value associated with the key. /// /// If there are multiple values associated with the key, then the first one /// is returned. Use `get_all` to get all values associated with a given /// key. Returns `None` if there are no values associated with the key. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// assert!(map.get("host").is_none()); /// /// map.insert(HOST, "hello".parse().unwrap()); /// assert_eq!(map.get(HOST).unwrap(), &"hello"); /// assert_eq!(map.get("host").unwrap(), &"hello"); /// /// map.append(HOST, "world".parse().unwrap()); /// assert_eq!(map.get("host").unwrap(), &"hello"); /// ``` pubfn get<K>(&self, key: K) -> Option<&T> where
K: AsHeaderName,
{ self.get2(&key)
}
fn get2<K>(&self, key: &K) -> Option<&T> where
K: AsHeaderName,
{ match key.find(self) {
Some((_, found)) => { let entry = &self.entries[found];
Some(&entry.value)
}
None => None,
}
}
/// Returns a mutable reference to the value associated with the key. /// /// If there are multiple values associated with the key, then the first one /// is returned. Use `entry` to get all values associated with a given /// key. Returns `None` if there are no values associated with the key. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::default(); /// map.insert(HOST, "hello".to_string()); /// map.get_mut("host").unwrap().push_str("-world"); /// /// assert_eq!(map.get(HOST).unwrap(), &"hello-world"); /// ``` pubfn get_mut<K>(&mutself, key: K) -> Option<&>mut T> where
K: AsHeaderName,
{ match key.find(self) {
Some((_, found)) => { let entry = &mutself.entries[found];
Some(&mut entry.value)
}
None => None,
}
}
/// Returns a view of all values associated with a key. /// /// The returned view does not incur any allocations and allows iterating /// the values associated with the key. See [`GetAll`] for more details. /// Returns `None` if there are no values associated with the key. /// /// [`GetAll`]: struct.GetAll.html /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// /// map.insert(HOST, "hello".parse().unwrap()); /// map.append(HOST, "goodbye".parse().unwrap()); /// /// let view = map.get_all("host"); /// /// let mut iter = view.iter(); /// assert_eq!(&"hello", iter.next().unwrap()); /// assert_eq!(&"goodbye", iter.next().unwrap()); /// assert!(iter.next().is_none()); /// ``` pubfn get_all<K>(&self, key: K) -> GetAll<'_, T> where
K: AsHeaderName,
{
GetAll {
map: self,
index: key.find(self).map(|(_, i)| i),
}
}
/// Returns true if the map contains a value for the specified key. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// assert!(!map.contains_key(HOST)); /// /// map.insert(HOST, "world".parse().unwrap()); /// assert!(map.contains_key("host")); /// ``` pubfn contains_key<K>(&self, key: K) -> bool where
K: AsHeaderName,
{
key.find(self).is_some()
}
/// An iterator visiting all key-value pairs. /// /// The iteration order is arbitrary, but consistent across platforms for /// the same crate version. Each key will be yielded once per associated /// value. So, if a key has 3 associated values, it will be yielded 3 times. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST}; /// let mut map = HeaderMap::new(); /// /// map.insert(HOST, "hello".parse().unwrap()); /// map.append(HOST, "goodbye".parse().unwrap()); /// map.insert(CONTENT_LENGTH, "123".parse().unwrap()); /// /// for (key, value) in map.iter() { /// println!("{:?}: {:?}", key, value); /// } /// ``` pubfn iter(&self) -> Iter<'_, T> {
Iter {
inner: IterMut {
map: selfas *const _ as *mut _,
entry: 0,
cursor: self.entries.first().map(|_| Cursor::Head),
lt: PhantomData,
},
}
}
/// An iterator visiting all key-value pairs, with mutable value references. /// /// The iterator order is arbitrary, but consistent across platforms for the /// same crate version. Each key will be yielded once per associated value, /// so if a key has 3 associated values, it will be yielded 3 times. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST}; /// let mut map = HeaderMap::default(); /// /// map.insert(HOST, "hello".to_string()); /// map.append(HOST, "goodbye".to_string()); /// map.insert(CONTENT_LENGTH, "123".to_string()); /// /// for (key, value) in map.iter_mut() { /// value.push_str("-boop"); /// } /// ``` pubfn iter_mut(&mutself) -> IterMut<'_, T> {
IterMut {
map: selfas *mut _,
entry: 0,
cursor: self.entries.first().map(|_| Cursor::Head),
lt: PhantomData,
}
}
/// An iterator visiting all keys. /// /// The iteration order is arbitrary, but consistent across platforms for /// the same crate version. Each key will be yielded only once even if it /// has multiple associated values. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST}; /// let mut map = HeaderMap::new(); /// /// map.insert(HOST, "hello".parse().unwrap()); /// map.append(HOST, "goodbye".parse().unwrap()); /// map.insert(CONTENT_LENGTH, "123".parse().unwrap()); /// /// for key in map.keys() { /// println!("{:?}", key); /// } /// ``` pubfn keys(&self) -> Keys<'_, T> {
Keys {
inner: self.entries.iter(),
}
}
/// An iterator visiting all values. /// /// The iteration order is arbitrary, but consistent across platforms for /// the same crate version. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST}; /// let mut map = HeaderMap::new(); /// /// map.insert(HOST, "hello".parse().unwrap()); /// map.append(HOST, "goodbye".parse().unwrap()); /// map.insert(CONTENT_LENGTH, "123".parse().unwrap()); /// /// for value in map.values() { /// println!("{:?}", value); /// } /// ``` pubfn values(&self) -> Values<'_, T> {
Values { inner: self.iter() }
}
/// An iterator visiting all values mutably. /// /// The iteration order is arbitrary, but consistent across platforms for /// the same crate version. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST}; /// let mut map = HeaderMap::default(); /// /// map.insert(HOST, "hello".to_string()); /// map.append(HOST, "goodbye".to_string()); /// map.insert(CONTENT_LENGTH, "123".to_string()); /// /// for value in map.values_mut() { /// value.push_str("-boop"); /// } /// ``` pubfn values_mut(&mutself) -> ValuesMut<'_, T> {
ValuesMut {
inner: self.iter_mut(),
}
}
/// Clears the map, returning all entries as an iterator. /// /// The internal memory is kept for reuse. /// /// For each yielded item that has `None` provided for the `HeaderName`, /// then the associated header name is the same as that of the previously /// yielded item. The first yielded item will have `HeaderName` set. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::{CONTENT_LENGTH, HOST}; /// let mut map = HeaderMap::new(); /// /// map.insert(HOST, "hello".parse().unwrap()); /// map.append(HOST, "goodbye".parse().unwrap()); /// map.insert(CONTENT_LENGTH, "123".parse().unwrap()); /// /// let mut drain = map.drain(); /// /// /// assert_eq!(drain.next(), Some((Some(HOST), "hello".parse().unwrap()))); /// assert_eq!(drain.next(), Some((None, "goodbye".parse().unwrap()))); /// /// assert_eq!(drain.next(), Some((Some(CONTENT_LENGTH), "123".parse().unwrap()))); /// /// assert_eq!(drain.next(), None); /// ``` pubfn drain(&mutself) -> Drain<'_, T> { for i inself.indices.iter_mut() {
*i = Pos::none();
}
// Memory safety // // When the Drain is first created, it shortens the length of // the source vector to make sure no uninitialized or moved-from // elements are accessible at all if the Drain's destructor never // gets to run.
let entries = &mutself.entries[..] as *mut _; let extra_values = &mutself.extra_values as *mut _; let len = self.entries.len(); unsafe { self.entries.set_len(0); }
/// Gets the given key's corresponding entry in the map for in-place /// manipulation. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// let mut map: HeaderMap<u32> = HeaderMap::default(); /// /// let headers = &[ /// "content-length", /// "x-hello", /// "Content-Length", /// "x-world", /// ]; /// /// for &header in headers { /// let counter = map.entry(header).or_insert(0); /// *counter += 1; /// } /// /// assert_eq!(map["content-length"], 2); /// assert_eq!(map["x-hello"], 1); /// ``` pubfn entry<K>(&mutself, key: K) -> Entry<'_, T> where
K: IntoHeaderName,
{
key.entry(self)
}
/// Gets the given key's corresponding entry in the map for in-place /// manipulation. /// /// # Errors /// /// This method differs from `entry` by allowing types that may not be /// valid `HeaderName`s to passed as the key (such as `String`). If they /// do not parse as a valid `HeaderName`, this returns an /// `InvalidHeaderName` error. pubfn try_entry<K>(&mutself, key: K) -> Result<Entry<'_, T>, InvalidHeaderName> where
K: AsHeaderName,
{
key.try_entry(self)
}
fn entry2<K>(&mutself, key: K) -> Entry<'_, T> where
K: Hash + Into<HeaderName>,
HeaderName: PartialEq<K>,
{ // Ensure that there is space in the map self.reserve_one();
/// Inserts a key-value pair into the map. /// /// If the map did not previously have this key present, then `None` is /// returned. /// /// If the map did have this key present, the new value is associated with /// the key and all previous values are removed. **Note** that only a single /// one of the previous values is returned. If there are multiple values /// that have been previously associated with the key, then the first one is /// returned. See `insert_mult` on `OccupiedEntry` for an API that returns /// all values. /// /// The key is not updated, though; this matters for types that can be `==` /// without being identical. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// assert!(map.insert(HOST, "world".parse().unwrap()).is_none()); /// assert!(!map.is_empty()); /// /// let mut prev = map.insert(HOST, "earth".parse().unwrap()).unwrap(); /// assert_eq!("world", prev); /// ``` pubfn insert<K>(&mutself, key: K, val: T) -> Option<T> where
K: IntoHeaderName,
{
key.insert(self, val)
}
/// Set an occupied bucket to the given value #[inline] fn insert_occupied(&mutself, index: usize, value: T) -> T { iflet Some(links) = self.entries[index].links { self.remove_all_extra_values(links.next);
}
let entry = &mutself.entries[index];
mem::replace(&mut entry.value, value)
}
fn insert_occupied_mult(&mutself, index: usize, value: T) -> ValueDrain<'_, T> { let old; let links;
{ let entry = &mutself.entries[index];
old = mem::replace(&mut entry.value, value);
links = entry.links.take();
}
let raw_links = self.raw_links(); let extra_values = &mutself.extra_values;
let next = links.map(|l| {
drain_all_extra_values(raw_links, extra_values, l.next)
.into_iter()
});
/// Inserts a key-value pair into the map. /// /// If the map did not previously have this key present, then `false` is /// returned. /// /// If the map did have this key present, the new value is pushed to the end /// of the list of values currently associated with the key. The key is not /// updated, though; this matters for types that can be `==` without being /// identical. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// assert!(map.insert(HOST, "world".parse().unwrap()).is_none()); /// assert!(!map.is_empty()); /// /// map.append(HOST, "earth".parse().unwrap()); /// /// let values = map.get_all("host"); /// let mut i = values.iter(); /// assert_eq!("world", *i.next().unwrap()); /// assert_eq!("earth", *i.next().unwrap()); /// ``` pubfn append<K>(&mutself, key: K, value: T) -> bool where
K: IntoHeaderName,
{
key.append(self, value)
}
let hash = hash_elem_using(&self.danger, key); let mask = self.mask; letmut probe = desired_pos(mask, hash); letmut dist = 0;
probe_loop!(probe < self.indices.len(), { iflet Some((i, entry_hash)) = self.indices[probe].resolve() { if dist > probe_distance(mask, entry_hash, probe) { // give up when probe distance is too long return None;
} elseif entry_hash == hash && self.entries[i].key == *key { return Some((probe, i));
}
} else { return None;
}
dist += 1;
});
}
/// phase 2 is post-insert where we forward-shift `Pos` in the indices. #[inline] fn insert_phase_two(
&mutself,
key: HeaderName,
value: T,
hash: HashValue,
probe: usize,
danger: bool,
) -> usize { // Push the value and get the index let index = self.entries.len(); self.insert_entry(hash, key, value);
let num_displaced = do_insert_phase_two(&mutself.indices, probe, Pos::new(index, hash));
/// Removes a key from the map, returning the value associated with the key. /// /// Returns `None` if the map does not contain the key. If there are /// multiple values associated with the key, then the first one is returned. /// See `remove_entry_mult` on `OccupiedEntry` for an API that yields all /// values. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "hello.world".parse().unwrap()); /// /// let prev = map.remove(HOST).unwrap(); /// assert_eq!("hello.world", prev); /// /// assert!(map.remove(HOST).is_none()); /// ``` pubfn remove<K>(&mutself, key: K) -> Option<T> where
K: AsHeaderName,
{ match key.find(self) {
Some((probe, idx)) => { iflet Some(links) = self.entries[idx].links { self.remove_all_extra_values(links.next);
}
let entry = self.remove_found(probe, idx);
Some(entry.value)
}
None => None,
}
}
/// Remove an entry from the map. /// /// Warning: To avoid inconsistent state, extra values _must_ be removed /// for the `found` index (via `remove_all_extra_values` or similar) /// _before_ this method is called. #[inline] fn remove_found(&mutself, probe: usize, found: usize) -> Bucket<T> { // index `probe` and entry `found` is to be removed // use swap_remove, but then we need to update the index that points // to the other entry that has to move self.indices[probe] = Pos::none(); let entry = self.entries.swap_remove(found);
// correct index that points to the entry that had to swap places iflet Some(entry) = self.entries.get(found) { // was not last element // examine new element in `found` and find it in indices letmut probe = desired_pos(self.mask, entry.hash);
probe_loop!(probe < self.indices.len(), { iflet Some((i, _)) = self.indices[probe].resolve() { if i >= self.entries.len() { // found it self.indices[probe] = Pos::new(found, entry.hash); break;
}
}
});
/// Removes the `ExtraValue` at the given index. #[inline] fn remove_extra_value(&mutself, idx: usize) -> ExtraValue<T> { let raw_links = self.raw_links();
remove_extra_value(raw_links, &mutself.extra_values, idx)
}
fn remove_all_extra_values(&mutself, mut head: usize) { loop { let extra = self.remove_extra_value(head);
fn rebuild(&mutself) { // Loop over all entries and re-insert them into the map 'outer: for (index, entry) in self.entries.iter_mut().enumerate() { let hash = hash_elem_using(&self.danger, &entry.key); letmut probe = desired_pos(self.mask, hash); letmut dist = 0;
// Update the entry's hash code
entry.hash = hash;
probe_loop!(probe < self.indices.len(), { iflet Some((_, entry_hash)) = self.indices[probe].resolve() { // if existing element probed less than us, swap let their_dist = probe_distance(self.mask, entry_hash, probe);
fn reserve_one(&mutself) { let len = self.entries.len();
ifself.danger.is_yellow() { let load_factor = self.entries.len() as f32 / self.indices.len() as f32;
if load_factor >= LOAD_FACTOR_THRESHOLD { // Transition back to green danger level self.danger.to_green();
// Double the capacity let new_cap = self.indices.len() * 2;
// Grow the capacity self.grow(new_cap);
} else { self.danger.to_red();
// Rebuild hash table for index inself.indices.iter_mut() {
*index = Pos::none();
}
self.rebuild();
}
} elseif len == self.capacity() { if len == 0 { let new_raw_cap = 8; self.mask = 8 - 1; self.indices = vec![Pos::none(); new_raw_cap].into_boxed_slice(); self.entries = Vec::with_capacity(usable_capacity(new_raw_cap));
} else { let raw_cap = self.indices.len(); self.grow(raw_cap << 1);
}
}
}
#[inline] fn grow(&mutself, new_raw_cap: usize) {
assert!(new_raw_cap <= MAX_SIZE, "requested capacity too large"); // This path can never be reached when handling the first allocation in // the map.
// find first ideally placed element -- start of cluster letmut first_ideal = 0;
// visit the entries in an order where we can simply reinsert them // into self.indices without any bucket stealing. let old_indices = mem::replace(
&mutself.indices,
vec![Pos::none(); new_raw_cap].into_boxed_slice(),
); self.mask = new_raw_cap.wrapping_sub(1) as Size;
for &pos in &old_indices[first_ideal..] { self.reinsert_entry_in_order(pos);
}
for &pos in &old_indices[..first_ideal] { self.reinsert_entry_in_order(pos);
}
// Reserve additional entry slots let more = self.capacity() - self.entries.len(); self.entries.reserve_exact(more);
}
/// Removes the `ExtraValue` at the given index. #[inline] fn remove_extra_value<T>( mut raw_links: RawLinks<T>,
extra_values: &mut Vec<ExtraValue<T>>,
idx: usize)
-> ExtraValue<T>
{ let prev; let next;
{
debug_assert!(extra_values.len() > idx); let extra = &extra_values[idx];
prev = extra.prev;
next = extra.next;
}
// First unlink the extra value match (prev, next) {
(Link::Entry(prev), Link::Entry(next)) => {
debug_assert_eq!(prev, next);
// Remove the extra value letmut extra = extra_values.swap_remove(idx);
// This is the index of the value that was moved (possibly `extra`) let old_idx = extra_values.len();
// Update the links if extra.prev == Link::Extra(old_idx) {
extra.prev = Link::Extra(idx);
}
if extra.next == Link::Extra(old_idx) {
extra.next = Link::Extra(idx);
}
// Check if another entry was displaced. If it was, then the links // need to be fixed. if idx != old_idx { let next; let prev;
{
debug_assert!(extra_values.len() > idx); let moved = &extra_values[idx];
next = moved.next;
prev = moved.prev;
}
// An entry was moved, we have to the links match prev {
Link::Entry(entry_idx) => { // It is critical that we do not attempt to read the // header name or value as that memory may have been // "released" already.
debug_assert!(raw_links[entry_idx].is_some());
impl<T> IntoIterator for HeaderMap<T> { type Item = (Option<HeaderName>, T); type IntoIter = IntoIter<T>;
/// Creates a consuming iterator, that is, one that moves keys and values /// out of the map in arbitrary order. The map cannot be used after calling /// this. /// /// For each yielded item that has `None` provided for the `HeaderName`, /// then the associated header name is the same as that of the previously /// yielded item. The first yielded item will have `HeaderName` set. /// /// # Examples /// /// Basic usage. /// /// ``` /// # use http::header; /// # use http::header::*; /// let mut map = HeaderMap::new(); /// map.insert(header::CONTENT_LENGTH, "123".parse().unwrap()); /// map.insert(header::CONTENT_TYPE, "json".parse().unwrap()); /// /// let mut iter = map.into_iter(); /// assert_eq!(iter.next(), Some((Some(header::CONTENT_LENGTH), "123".parse().unwrap()))); /// assert_eq!(iter.next(), Some((Some(header::CONTENT_TYPE), "json".parse().unwrap()))); /// assert!(iter.next().is_none()); /// ``` /// /// Multiple values per key. /// /// ``` /// # use http::header; /// # use http::header::*; /// let mut map = HeaderMap::new(); /// /// map.append(header::CONTENT_LENGTH, "123".parse().unwrap()); /// map.append(header::CONTENT_LENGTH, "456".parse().unwrap()); /// /// map.append(header::CONTENT_TYPE, "json".parse().unwrap()); /// map.append(header::CONTENT_TYPE, "html".parse().unwrap()); /// map.append(header::CONTENT_TYPE, "xml".parse().unwrap()); /// /// let mut iter = map.into_iter(); /// /// assert_eq!(iter.next(), Some((Some(header::CONTENT_LENGTH), "123".parse().unwrap()))); /// assert_eq!(iter.next(), Some((None, "456".parse().unwrap()))); /// /// assert_eq!(iter.next(), Some((Some(header::CONTENT_TYPE), "json".parse().unwrap()))); /// assert_eq!(iter.next(), Some((None, "html".parse().unwrap()))); /// assert_eq!(iter.next(), Some((None, "xml".parse().unwrap()))); /// assert!(iter.next().is_none()); /// ``` fn into_iter(self) -> IntoIter<T> {
IntoIter {
next: None,
entries: self.entries.into_iter(),
extra_values: self.extra_values,
}
}
}
/// Try to convert a `HashMap` into a `HeaderMap`. /// /// # Examples /// /// ``` /// use std::collections::HashMap; /// use std::convert::TryInto; /// use http::HeaderMap; /// /// let mut map = HashMap::new(); /// map.insert("X-Custom-Header".to_string(), "my value".to_string()); /// /// let headers: HeaderMap = (&map).try_into().expect("valid headers"); /// assert_eq!(headers["X-Custom-Header"], "my value"); /// ``` impl<'a, K, V, T> TryFrom<&'a HashMap<K, V>> for HeaderMap<T> where
K: Eq + Hash,
HeaderName: TryFrom<&'a K>,
<HeaderName as TryFrom<&'a K>>::Error: Into<crate::Error>,
T: TryFrom<&'a V>,
T::Error: Into<crate::Error>,
{ type Error = Error;
fn try_from(c: &'a HashMap<K, V>) -> Result<Self, Self::Error> {
c.into_iter()
.map(|(k, v)| -> crate::Result<(HeaderName, T)> { let name = TryFrom::try_from(k).map_err(Into::into)?; let value = TryFrom::try_from(v).map_err(Into::into)?;
Ok((name, value))
})
.collect()
}
}
impl<T> Extend<(Option<HeaderName>, T)> for HeaderMap<T> { /// Extend a `HeaderMap` with the contents of another `HeaderMap`. /// /// This function expects the yielded items to follow the same structure as /// `IntoIter`. /// /// # Panics /// /// This panics if the first yielded item does not have a `HeaderName`. /// /// # Examples /// /// ``` /// # use http::header::*; /// let mut map = HeaderMap::new(); /// /// map.insert(ACCEPT, "text/plain".parse().unwrap()); /// map.insert(HOST, "hello.world".parse().unwrap()); /// /// let mut extra = HeaderMap::new(); /// /// extra.insert(HOST, "foo.bar".parse().unwrap()); /// extra.insert(COOKIE, "hello".parse().unwrap()); /// extra.append(COOKIE, "world".parse().unwrap()); /// /// map.extend(extra); /// /// assert_eq!(map["host"], "foo.bar"); /// assert_eq!(map["accept"], "text/plain"); /// assert_eq!(map["cookie"], "hello"); /// /// let v = map.get_all("host"); /// assert_eq!(1, v.iter().count()); /// /// let v = map.get_all("cookie"); /// assert_eq!(2, v.iter().count()); /// ``` fn extend<I: IntoIterator<Item = (Option<HeaderName>, T)>>(&mutself, iter: I) { letmut iter = iter.into_iter();
// The structure of this is a bit weird, but it is mostly to make the // borrow checker happy. let (mut key, mut val) = match iter.next() {
Some((Some(key), val)) => (key, val),
Some((None, _)) => panic!("expected a header name, but got None"),
None => return,
};
'outer: loop { letmut entry = matchself.entry2(key) {
Entry::Occupied(mut e) => { // Replace all previous values while maintaining a handle to // the entry.
e.insert(val);
e
}
Entry::Vacant(e) => e.insert_entry(val),
};
// As long as `HeaderName` is none, keep inserting the value into // the current entry loop { match iter.next() {
Some((Some(k), v)) => {
key = k;
val = v; continue'outer;
}
Some((None, v)) => {
entry.append(v);
}
None => { return;
}
}
}
}
}
}
impl<T> Extend<(HeaderName, T)> for HeaderMap<T> { fn extend<I: IntoIterator<Item = (HeaderName, T)>>(&mutself, iter: I) { // Keys may be already present or show multiple times in the iterator. // Reserve the entire hint lower bound if the map is empty. // Otherwise reserve half the hint (rounded up), so the map // will only resize twice in the worst case. let iter = iter.into_iter();
impl<'a, K, T> ops::Index<K> for HeaderMap<T> where
K: AsHeaderName,
{ type Output = T;
/// # Panics /// Using the index operator will cause a panic if the header you're querying isn't set. #[inline] fn index(&self, index: K) -> &T { matchself.get2(&index) {
Some(val) => val,
None => panic!("no entry found for key {:?}", index.as_str()),
}
}
}
/// phase 2 is post-insert where we forward-shift `Pos` in the indices. /// /// returns the number of displaced elements #[inline] fn do_insert_phase_two(indices: &mut [Pos], mut probe: usize, mutold_pos: Pos) -> usize { letmut num_displaced = 0;
probe_loop!(probe < indices.len(), { let pos = &mut indices[probe];
let lower = map.entries.len() - self.entry; // We could pessimistically guess at the upper bound, saying // that its lower + map.extra_values.len(). That could be // way over though, such as if we're near the end, and have // already gone through several extra values...
(lower, None)
}
}
impl<'a, T> FusedIterator for IterMut<'a, T> {}
unsafeimpl<'a, T: Sync> Sync for IterMut<'a, T> {} unsafeimpl<'a, T: Send> Send for IterMut<'a, T> {}
// ===== impl Keys =====
impl<'a, T> Iterator for Keys<'a, T> { type Item = &'a HeaderName;
// Read the header name let key = ptr::read(&entry.key as *const _); let value = ptr::read(&entry.value as *const _); self.next = entry.links.map(|l| l.next);
Some((Some(key), value))
}
}
fn size_hint(&self) -> (usize, Option<usize>) { // At least this many names... It's unknown if the user wants // to count the extra_values on top. // // For instance, extending a new `HeaderMap` wouldn't need to // reserve the upper-bound in `entries`, only the lower-bound. let lower = self.len - self.idx; let upper = unsafe { (*self.extra_values).len() } + lower;
(lower, Some(upper))
}
}
impl<'a, T> FusedIterator for Drain<'a, T> {}
impl<'a, T> Drop for Drain<'a, T> { fn drop(&mutself) { for _ inself {}
}
}
unsafeimpl<'a, T: Sync> Sync for Drain<'a, T> {} unsafeimpl<'a, T: Send> Send for Drain<'a, T> {}
// ===== impl Entry =====
impl<'a, T> Entry<'a, T> { /// Ensures a value is in the entry by inserting the default if empty. /// /// Returns a mutable reference to the **first** value in the entry. /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// let mut map: HeaderMap<u32> = HeaderMap::default(); /// /// let headers = &[ /// "content-length", /// "x-hello", /// "Content-Length", /// "x-world", /// ]; /// /// for &header in headers { /// let counter = map.entry(header) /// .or_insert(0); /// *counter += 1; /// } /// /// assert_eq!(map["content-length"], 2); /// assert_eq!(map["x-hello"], 1); /// ``` pubfn or_insert(self, default: T) -> &'a mut T { useself::Entry::*;
/// Ensures a value is in the entry by inserting the result of the default /// function if empty. /// /// The default function is not called if the entry exists in the map. /// Returns a mutable reference to the **first** value in the entry. /// /// # Examples /// /// Basic usage. /// /// ``` /// # use http::HeaderMap; /// let mut map = HeaderMap::new(); /// /// let res = map.entry("x-hello") /// .or_insert_with(|| "world".parse().unwrap()); /// /// assert_eq!(res, "world"); /// ``` /// /// The default function is not called if the entry exists in the map. /// /// ``` /// # use http::HeaderMap; /// # use http::header::HOST; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "world".parse().unwrap()); /// /// let res = map.entry("host") /// .or_insert_with(|| unreachable!()); /// /// /// assert_eq!(res, "world"); /// ``` pubfn or_insert_with<F: FnOnce() -> T>(self, default: F) -> &'a mut T { useself::Entry::*;
impl<'a, T> VacantEntry<'a, T> { /// Returns a reference to the entry's key /// /// # Examples /// /// ``` /// # use http::HeaderMap; /// let mut map = HeaderMap::new(); /// /// assert_eq!(map.entry("x-hello").key().as_str(), "x-hello"); /// ``` pubfn key(&self) -> &HeaderName {
&self.key
}
/// Take ownership of the key /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry}; /// let mut map = HeaderMap::new(); /// /// if let Entry::Vacant(v) = map.entry("x-hello") { /// assert_eq!(v.into_key().as_str(), "x-hello"); /// } /// ``` pubfn into_key(self) -> HeaderName { self.key
}
/// Insert the value into the entry. /// /// The value will be associated with this entry's key. A mutable reference /// to the inserted value will be returned. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry}; /// let mut map = HeaderMap::new(); /// /// if let Entry::Vacant(v) = map.entry("x-hello") { /// v.insert("world".parse().unwrap()); /// } /// /// assert_eq!(map["x-hello"], "world"); /// ``` pubfn insert(self, value: T) -> &'a mut T { // Ensure that there is space in the map let index = self.map
.insert_phase_two(self.key, value.into(), self.hash, self.probe, self.danger);
&mutself.map.entries[index].value
}
/// Insert the value into the entry. /// /// The value will be associated with this entry's key. The new /// `OccupiedEntry` is returned, allowing for further manipulation. /// /// # Examples /// /// ``` /// # use http::header::*; /// let mut map = HeaderMap::new(); /// /// if let Entry::Vacant(v) = map.entry("x-hello") { /// let mut e = v.insert_entry("world".parse().unwrap()); /// e.insert("world2".parse().unwrap()); /// } /// /// assert_eq!(map["x-hello"], "world2"); /// ``` pubfn insert_entry(self, value: T) -> OccupiedEntry<'a, T> { // Ensure that there is space in the map let index = self.map
.insert_phase_two(self.key, value.into(), self.hash, self.probe, self.danger);
let value = unsafe { ptr::read(&self.extra_values[next].value) };
return Some((None, value));
}
iflet Some(bucket) = self.entries.next() { self.next = bucket.links.map(|l| l.next); let name = Some(bucket.key); let value = bucket.value;
return Some((name, value));
}
None
}
fn size_hint(&self) -> (usize, Option<usize>) { let (lower, _) = self.entries.size_hint(); // There could be more than just the entries upper, as there // could be items in the `extra_values`. We could guess, saying // `upper + extra_values.len()`, but that could overestimate by a lot.
(lower, None)
}
}
impl<T> FusedIterator for IntoIter<T> {}
impl<T> Drop for IntoIter<T> { fn drop(&mutself) { // Ensure the iterator is consumed for _ inself.by_ref() {}
// All the values have already been yielded out. unsafe { self.extra_values.set_len(0);
}
}
}
// ===== impl OccupiedEntry =====
impl<'a, T> OccupiedEntry<'a, T> { /// Returns a reference to the entry's key. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "world".parse().unwrap()); /// /// if let Entry::Occupied(e) = map.entry("host") { /// assert_eq!("host", e.key()); /// } /// ``` pubfn key(&self) -> &HeaderName {
&self.map.entries[self.index].key
}
/// Get a reference to the first value in the entry. /// /// Values are stored in insertion order. /// /// # Panics /// /// `get` panics if there are no values associated with the entry. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "hello.world".parse().unwrap()); /// /// if let Entry::Occupied(mut e) = map.entry("host") { /// assert_eq!(e.get(), &"hello.world"); /// /// e.append("hello.earth".parse().unwrap()); /// /// assert_eq!(e.get(), &"hello.world"); /// } /// ``` pubfn get(&self) -> &T {
&self.map.entries[self.index].value
}
/// Get a mutable reference to the first value in the entry. /// /// Values are stored in insertion order. /// /// # Panics /// /// `get_mut` panics if there are no values associated with the entry. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::default(); /// map.insert(HOST, "hello.world".to_string()); /// /// if let Entry::Occupied(mut e) = map.entry("host") { /// e.get_mut().push_str("-2"); /// assert_eq!(e.get(), &"hello.world-2"); /// } /// ``` pubfn get_mut(&mutself) -> &mut T {
&mutself.map.entries[self.index].value
}
/// Converts the `OccupiedEntry` into a mutable reference to the **first** /// value. /// /// The lifetime of the returned reference is bound to the original map. /// /// # Panics /// /// `into_mut` panics if there are no values associated with the entry. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::default(); /// map.insert(HOST, "hello.world".to_string()); /// map.append(HOST, "hello.earth".to_string()); /// /// if let Entry::Occupied(e) = map.entry("host") { /// e.into_mut().push_str("-2"); /// } /// /// assert_eq!("hello.world-2", map["host"]); /// ``` pubfn into_mut(self) -> &'a mut T {
&mutself.map.entries[self.index].value
}
/// Sets the value of the entry. /// /// All previous values associated with the entry are removed and the first /// one is returned. See `insert_mult` for an API that returns all values. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "hello.world".parse().unwrap()); /// /// if let Entry::Occupied(mut e) = map.entry("host") { /// let mut prev = e.insert("earth".parse().unwrap()); /// assert_eq!("hello.world", prev); /// } /// /// assert_eq!("earth", map["host"]); /// ``` pubfn insert(&mutself, value: T) -> T { self.map.insert_occupied(self.index, value.into())
}
/// Sets the value of the entry. /// /// This function does the same as `insert` except it returns an iterator /// that yields all values previously associated with the key. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "world".parse().unwrap()); /// map.append(HOST, "world2".parse().unwrap()); /// /// if let Entry::Occupied(mut e) = map.entry("host") { /// let mut prev = e.insert_mult("earth".parse().unwrap()); /// assert_eq!("world", prev.next().unwrap()); /// assert_eq!("world2", prev.next().unwrap()); /// assert!(prev.next().is_none()); /// } /// /// assert_eq!("earth", map["host"]); /// ``` pubfn insert_mult(&mutself, value: T) -> ValueDrain<'_, T> { self.map.insert_occupied_mult(self.index, value.into())
}
/// Insert the value into the entry. /// /// The new value is appended to the end of the entry's value list. All /// previous values associated with the entry are retained. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "world".parse().unwrap()); /// /// if let Entry::Occupied(mut e) = map.entry("host") { /// e.append("earth".parse().unwrap()); /// } /// /// let values = map.get_all("host"); /// let mut i = values.iter(); /// assert_eq!("world", *i.next().unwrap()); /// assert_eq!("earth", *i.next().unwrap()); /// ``` pubfn append(&mutself, value: T) { let idx = self.index; let entry = &mutself.map.entries[idx];
append_value(idx, entry, &mutself.map.extra_values, value.into());
}
/// Remove the entry from the map. /// /// All values associated with the entry are removed and the first one is /// returned. See `remove_entry_mult` for an API that returns all values. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "world".parse().unwrap()); /// /// if let Entry::Occupied(e) = map.entry("host") { /// let mut prev = e.remove(); /// assert_eq!("world", prev); /// } /// /// assert!(!map.contains_key("host")); /// ``` pubfn remove(self) -> T { self.remove_entry().1
}
/// Remove the entry from the map. /// /// The key and all values associated with the entry are removed and the /// first one is returned. See `remove_entry_mult` for an API that returns /// all values. /// /// # Examples /// /// ``` /// # use http::header::{HeaderMap, Entry, HOST}; /// let mut map = HeaderMap::new(); /// map.insert(HOST, "world".parse().unwrap()); /// /// if let Entry::Occupied(e) = map.entry("host") { /// let (key, mut prev) = e.remove_entry(); /// assert_eq!("host", key.as_str()); /// assert_eq!("world", prev); /// } /// /// assert!(!map.contains_key("host")); /// ``` pubfn remove_entry(self) -> (HeaderName, T) { iflet Some(links) = self.map.entries[self.index].links { self.map.remove_all_extra_values(links.next);
}
let entry = self.map.remove_found(self.probe, self.index);
(entry.key, entry.value)
}
/// Remove the entry from the map. /// /// The key and all values associated with the entry are removed and /// returned. pubfn remove_entry_mult(self) -> (HeaderName, ValueDrain<'a, T>) { let raw_links = self.map.raw_links(); let extra_values = &mutself.map.extra_values;
let next = self.map.entries[self.index].links.map(|l| {
drain_all_extra_values(raw_links, extra_values, l.next)
.into_iter()
});
let entry = self.map.remove_found(self.probe, self.index);
/// The number of steps that `current` is forward of the desired position for hash #[inline] fn probe_distance(mask: Size, hash: HashValue, current: usize) -> usize {
current.wrapping_sub(desired_pos(mask, hash)) & mask as usize
}
fn hash_elem_using<K: ?Sized>(danger: &Danger, k: &K) -> HashValue where
K: Hash,
{ use fnv::FnvHasher;
const MASK: u64 = (MAX_SIZE as u64) - 1;
let hash = match *danger { // Safe hash
Danger::Red(ref hasher) => { letmut h = hasher.build_hasher();
k.hash(&mut h);
h.finish()
} // Fast hash
_ => { letmut h = FnvHasher::default();
k.hash(&mut h);
h.finish()
}
};
mod into_header_name { usesuper::{Entry, HdrName, HeaderMap, HeaderName};
/// A marker trait used to identify values that can be used as insert keys /// to a `HeaderMap`. pubtrait IntoHeaderName: Sealed {}
// All methods are on this pub(super) trait, instead of `IntoHeaderName`, // so that they aren't publicly exposed to the world. // // Being on the `IntoHeaderName` trait would mean users could call // `"host".insert(&mut map, "localhost")`. // // Ultimately, this allows us to adjust the signatures of these methods // without breaking any external crate. pubtrait Sealed { #[doc(hidden)] fn insert<T>(self, map: &mut HeaderMap<T>, val: T) -> Option<T>;
mod as_header_name { usesuper::{Entry, HdrName, HeaderMap, HeaderName, InvalidHeaderName};
/// A marker trait used to identify values that can be used as search keys /// to a `HeaderMap`. pubtrait AsHeaderName: Sealed {}
// All methods are on this pub(super) trait, instead of `AsHeaderName`, // so that they aren't publicly exposed to the world. // // Being on the `AsHeaderName` trait would mean users could call // `"host".find(&map)`. // // Ultimately, this allows us to adjust the signatures of these methods // without breaking any external crate. pubtrait Sealed { #[doc(hidden)] fn try_entry<T>(self, map: &mut HeaderMap<T>) -> Result<Entry<'_, T>, InvalidHeaderName>;
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.