Struct rocket::http::hyper::header::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 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.

source

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

Access the raw value of a header.

Prefer to use the typed getters instead.

Example:

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

pub fn set_raw<K>(&mut self, name: K, value: Vec<Vec<u8>>)
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()]);
source

pub fn append_raw<K>(&mut self, name: K, value: Vec<u8>)
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());
source

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

Remove a header set by set_raw

source

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

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 + HeaderFormat,

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

source

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

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.

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.

Trait Implementations§

source§

impl Clone for Headers

source§

fn clone(&self) -> Headers

Returns a copy 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 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<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> 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, I> AsResult<T, I> for T
where I: Input,

source§

fn as_result(self) -> Result<T, ParseErr<I>>

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
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§

default 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.
source§

impl<T> Typeable for T
where T: Any,

source§

fn get_type(&self) -> TypeId

Get the TypeId of this object.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V