Struct Headers

pub struct Headers { /* private fields */ }

An immutable view of headers

Implementations

impl Headers

pub fn new() -> Self

Create an empty header map

pub fn get(&self, key: impl AsRef<str>) -> Option<&str>

Returns the value for a given key

If multiple values are associated, the first value is returned See HeaderMap::get

pub fn get_all(&self, key: impl AsRef<str>) -> impl Iterator<Item = &str>

Returns all values for a given key

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

Returns an iterator over the headers

pub fn len(&self) -> usize

Returns the total number of values stored in the map

pub fn is_empty(&self) -> bool

Returns true if there are no headers

pub fn contains_key(&self, key: impl AsRef<str>) -> bool

Returns true if this header is present

pub fn insert( &mut self, key: impl AsHeaderComponent, value: impl AsHeaderComponent, ) -> Option<String>

Insert a value into the headers structure.

This will replace any existing value for this key. Returns the previous associated value if any.

Panics

If the key is not valid ASCII, or if the value is not valid UTF-8, this function will panic.

pub fn try_insert( &mut self, key: impl AsHeaderComponent, value: impl AsHeaderComponent, ) -> Result<Option<String>, HttpError>

Insert a value into the headers structure.

This will replace any existing value for this key. Returns the previous associated value if any.

If the key is not valid ASCII, or if the value is not valid UTF-8, this function will return an error.

pub fn append( &mut self, key: impl AsHeaderComponent, value: impl AsHeaderComponent, ) -> bool

Appends a value to a given key

Panics

If the key is not valid ASCII, or if the value is not valid UTF-8, this function will panic.

pub fn try_append( &mut self, key: impl AsHeaderComponent, value: impl AsHeaderComponent, ) -> Result<bool, HttpError>

Appends a value to a given key

If the key is not valid ASCII, or if the value is not valid UTF-8, this function will return an error.

pub fn remove(&mut self, key: impl AsRef<str>) -> Option<String>

Removes all headers with a given key

If there are multiple entries for this key, the first entry is returned

Trait Implementations

impl Clone for Headers

fn clone(&self) -> Headers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Headers

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

Formats the value using the given formatter.

impl Default for Headers

fn default() -> Headers

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a Headers

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = HeadersIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl TryFrom<HeaderMap> for Headers

Available on crate feature http-02x only.

type Error = HttpError

The type returned in the event of a conversion error.

fn try_from(value: HeaderMap) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HeaderMap> for Headers

Available on crate feature http-1x only.

type Error = HttpError

The type returned in the event of a conversion error.

fn try_from(value: HeaderMap) -> Result<Self, Self::Error>

Performs the conversion.