Struct websocket::header::Headers

pub struct Headers { /* fields omitted */ }

A map of header fields on requests and responses.

Implementations

impl Headers

pub fn new() -> Headers

Creates a new, empty headers map.

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

Set a header field to the corresponding value.

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

pub fn get_raw(&self, name: &str) -> Option<&[Vec<u8, Global>]>

Access the raw value of a header.

Prefer to use the typed getters instead.

Example:

let raw_content_type = headers.get_raw("content-type");

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

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

Note: This will completely replace any current value for this header name.

Example:

headers.set_raw("content-length", vec![b"5".to_vec()]);

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

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 doesnot 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 remove_raw(&mut self, name: &str)

Remove a header set by set_raw

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

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

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

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

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

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

Example:

let has_type = headers.has::<ContentType>();

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

Removes a header from the map, if one existed. Returns true if a header has been removed.

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.

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<(), Error>

Formats the value using the given formatter.

impl Display for Headers

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

Formats the value using the given formatter.

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

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

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> FromIterator<HeaderView<'a>> for Headers

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

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 !=.