Struct HeaderMap 

pub struct HeaderMap { /* private fields */ }

A multimap of HTTP header names to values.

Each header name may have one or more values. Methods such as get return the first value; use get_all to iterate over every value associated with a name.

Implementations

impl HeaderMap

pub fn new() -> HeaderMap

Creates an empty HeaderMap.

The map will be created without any capacity. This function will not allocate.

pub fn with_capacity(capacity: usize) -> HeaderMap

Creates 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.

pub fn len(&self) -> usize

Returns the number of keys stored in the map.

This counts distinct header names, not the total number of values.

pub fn is_empty(&self) -> bool

Returns true if the map contains no headers.

pub fn clear(&mut self)

Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse.

pub fn capacity(&self) -> usize

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.

pub fn reserve(&mut self, additional: usize)

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.

pub fn get<N>(&self, name: N) -> Option<&HeaderValue>

where N: AsName,

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.

pub fn get_all<N>(&self, name: N) -> GetAll<'_>

where N: AsName,

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. The iterator is empty if there are no values associated with the key.

pub fn get_mut<N>(&mut self, name: N) -> Option<&mut HeaderValue>

where N: AsName,

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 get_all to get all values associated with a given key. Returns None if there are no values associated with the key.

pub fn contains_key<N>(&self, key: N) -> bool

where N: AsName,

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

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

An iterator visiting all key-value pairs.

The iteration order is arbitrary and may vary between maps. Each key is yielded once per associated value.

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

An iterator visiting all keys.

The iteration order is arbitrary and may vary between maps. Each key is yielded only once, even if it has multiple associated values.

pub fn insert(&mut self, key: HeaderName, val: HeaderValue)

Inserts a key-value pair into the map.

The new value replaces all values previously associated with the key.

The key is not updated, though; this matters for types that can be == without being identical.

pub fn append(&mut self, key: HeaderName, value: HeaderValue)

Inserts a key-value pair into the map.

The value is appended after any values already associated with the key. The stored key itself is not replaced when an equivalent key exists.

pub fn remove<N>(&mut self, key: N)

where N: AsName,

Removes all headers for a particular header name from the map.

Trait Implementations

impl Clone for HeaderMap

fn clone(&self) -> HeaderMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderMap

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

Formats the value using the given formatter.

impl Default for HeaderMap

fn default() -> HeaderMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HeaderMap

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HeaderMap

impl From<HeaderMap> for HeaderMap

Converts an http::HeaderMap into an ntex HeaderMap.

fn from(map: HeaderMap) -> HeaderMap

Converts to this type from the input type.

impl<'a> IntoIterator for &'a HeaderMap

type Item = (&'a HeaderName, &'a HeaderValue)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a HeaderMap as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for HeaderMap

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HeaderMap

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HeaderMap