Struct Headers

Source
pub struct Headers { /* private fields */ }
Expand description

A map of header fields on requests and responses.

Implementations§

Source§

impl Headers

Source

pub fn new() -> Headers

Creates a new, empty headers map.

Source

pub fn with_capacity(len: usize) -> Headers

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

Source

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

Set a header field to the corresponding value.

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

Source

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

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

Source

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

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

Source

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

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

Example:

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

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

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.

Source

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

Returns an iterator over the header fields.

Source

pub fn len(&self) -> usize

Returns the number of headers in the map.

Source

pub fn clear(&mut self)

Remove all headers from the map.

Source

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");
Source

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

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']]);
Source

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

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());
Source

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

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

Source

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

Remove a header by name.

Trait Implementations§

Source§

impl Clone for Headers

Source§

fn clone(&self) -> Headers

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Headers

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Headers

Source§

fn default() -> Headers

Returns the “default value” for a type. Read more
Source§

impl Display for Headers

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

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

Source§

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

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<HeaderMap> for Headers

Source§

fn from(header_map: HeaderMap) -> Headers

Converts to this type from the input type.
Source§

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

Source§

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

Creates a value from an iterator. Read more
Source§

impl PartialEq for Headers

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.