Struct hyperx::header::Headers

pub struct Headers { /* fields omitted */ }

A specialized map of typed headers.

This type is only available with the non-default headers feature enabled. The type is preserved for compatibly, but its use is no longer required nor recommended. Consider replacing with http::HeaderMap and its TypedHeaders extension.

Implementations

impl Headers

pub fn new() -> Headers

Creates a new, empty headers map.

pub fn with_capacity(len: usize) -> Headers

Creates a new Headers struct with space reserved for len headers.

pub fn set<H: Header>(&mut self, value: H)

Set a header field to the corresponding value.

The field is determined by the type of the value being set.

pub fn get<H: Header>(&self) -> Option<&H>

Get a reference to the header field's value, if it exists.

pub fn get_mut<H: Header>(&mut self) -> Option<&mut H>

Get a mutable reference to the header field's value, if it exists.

pub fn has<H: Header>(&self) -> bool

Returns a boolean of whether a certain header is in the map.

Example:

headers.set(ContentType::json());
assert!(headers.has::<ContentType>());

pub fn remove<H: Header>(&mut self) -> Option<H>

Removes a header from the map, if one existed. Returns the header, if one has been removed and could be parsed.

Note that this function may return None even though a header was removed. If you want to know whether a header exists, rather rely on has.

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

Returns an iterator over the header fields.

pub fn len(&self) -> usize

Returns the number of headers in the map.

pub fn clear(&mut self)

Remove all headers from the map.

pub fn get_raw(&self, name: &str) -> Option<&Raw>

Access the raw value of a header.

Prefer to use the typed getters instead.

Example:

let raw = headers.get_raw("content-type").unwrap();
assert_eq!(raw, "text/plain");

pub fn set_raw<K: Into<Cow<'static, str>>, V: Into<Raw>>(
    &mut self,
    name: K,
    value: V
)

Set the raw value of a header, bypassing any typed headers.

Example:

headers.set_raw("content-length", b"1".as_ref());
headers.set_raw("content-length", "2");
headers.set_raw("content-length", "3".to_string());
headers.set_raw("content-length", vec![vec![b'4']]);

pub fn append_raw<K: Into<Cow<'static, str>>, V: Into<Raw>>(
    &mut self,
    name: K,
    value: V
)

Append a value to raw value of this header.

If a header already contains a value, this will add another line to it.

If a header does not exist for this name, a new one will be created with the value.

Example:

headers.append_raw("x-foo", b"bar".to_vec());
headers.append_raw("x-foo", b"quux".to_vec());

pub fn append_raw_str<V: Into<Raw>>(&mut self, name: &str, value: V)

Alternative to append_raw that avoids an allocation if name already exists as a key.

pub fn remove_raw(&mut self, name: &str)

Remove a header by name.

Trait Implementations

impl Clone for Headers

pub fn clone(&self) -> Headers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Headers

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

Formats the value using the given formatter.

impl Default for Headers

pub fn default() -> Headers

Returns the "default value" for a type.

impl Display for Headers

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

Formats the value using the given formatter.

impl<'a> Extend<(&'a str, Bytes)> for Headers

pub fn extend<I: IntoIterator<Item = (&'a str, Bytes)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<HeaderView<'a>> for Headers

pub fn extend<I: IntoIterator<Item = HeaderView<'a>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<&'a HeaderMap<HeaderValue>> for Headers

pub fn from(header_map: &'a HeaderMap) -> Headers

Performs the conversion.

impl<'a> From<&'a Headers> for HeaderMap

pub fn from(headers: &'a Headers) -> HeaderMap

Performs the conversion.

impl From<HeaderMap<HeaderValue>> for Headers

pub fn from(header_map: HeaderMap) -> Headers

Performs the conversion.

impl From<Headers> for HeaderMap

pub fn from(headers: Headers) -> HeaderMap

Performs the conversion.

impl<'a> FromIterator<HeaderView<'a>> for Headers

pub fn from_iter<I: IntoIterator<Item = HeaderView<'a>>>(iter: I) -> Headers

Creates a value from an iterator.

impl PartialEq<Headers> for Headers

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.