Struct ntex::http::header::HeaderMap [−][src]
pub struct HeaderMap { /* fields omitted */ }
Expand description
A set of HTTP headers
HeaderMap
is an multimap of HeaderName
to values.
Implementations
impl HeaderMap
[src]
impl HeaderMap
[src]pub fn new() -> Self
[src]
pub fn new() -> Self
[src]Create an empty HeaderMap
.
The map will be created without any capacity. This function will not allocate.
pub fn with_capacity(capacity: usize) -> HeaderMap
[src]
pub fn with_capacity(capacity: usize) -> HeaderMap
[src]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.
pub fn len(&self) -> usize
[src]
pub fn len(&self) -> usize
[src]Returns the number of keys stored in the map.
This number could be be less than or equal to actual headers stored in the map.
pub fn clear(&mut self)
[src]
pub fn clear(&mut self)
[src]Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse.
pub fn capacity(&self) -> usize
[src]
pub fn capacity(&self) -> usize
[src]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)
[src]
pub fn reserve(&mut self, additional: usize)
[src]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: AsName>(&self, name: N) -> Option<&HeaderValue>
[src]
pub fn get<N: AsName>(&self, name: N) -> Option<&HeaderValue>
[src]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: AsName>(&self, name: N) -> GetAll<'_>
[src]
pub fn get_all<N: AsName>(&self, name: N) -> GetAll<'_>
[src]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.
pub fn get_mut<N: AsName>(&mut self, name: N) -> Option<&mut HeaderValue>
[src]
pub fn get_mut<N: AsName>(&mut self, name: N) -> Option<&mut HeaderValue>
[src]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.
pub fn contains_key<N: AsName>(&self, key: N) -> bool
[src]
pub fn contains_key<N: AsName>(&self, key: N) -> bool
[src]Returns true if the map contains a value for the specified key.
pub fn iter(&self) -> Iter<'_>
[src]
pub fn iter(&self) -> Iter<'_>
[src]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.
pub fn keys(&self) -> Keys<'_>
[src]
pub fn keys(&self) -> Keys<'_>
[src]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.
pub fn insert(&mut self, key: HeaderName, val: HeaderValue)
[src]
pub fn insert(&mut self, key: HeaderName, val: HeaderValue)
[src]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.
pub fn append(&mut self, key: HeaderName, value: HeaderValue)
[src]
pub fn append(&mut self, key: HeaderName, value: HeaderValue)
[src]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.
Trait Implementations
impl From<HeaderMap<HeaderValue>> for HeaderMap
[src]
impl From<HeaderMap<HeaderValue>> for HeaderMap
[src]Convert http::HeaderMap to a HeaderMap
impl<'a> IntoIterator for &'a HeaderMap
[src]
impl<'a> IntoIterator for &'a HeaderMap
[src]type Item = (&'a HeaderName, &'a HeaderValue)
type Item = (&'a HeaderName, &'a HeaderValue)
The type of the elements being iterated over.
type IntoIter = Iter<'a>
type IntoIter = Iter<'a>
Which kind of iterator are we turning this into?
Auto Trait Implementations
impl RefUnwindSafe for HeaderMap
impl Send for HeaderMap
impl Sync for HeaderMap
impl Unpin for HeaderMap
impl UnwindSafe for HeaderMap
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more