Struct trillium_http::Headers

source · [−]

pub struct Headers { /* private fields */ }

Expand description

Trillium’s header map type

Implementations

source

impl Headers

source

pub fn with_capacity(capacity: usize) -> Self

Construct a new Headers, expecting to see at least this many known headers.

source

pub fn new() -> Self

Construct a new headers with a default capacity of 15 known headers

source

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

Extend the capacity of the known headers map by this many

source

pub fn iter(&self) -> impl Iterator<Item = (HeaderName<'_>, &HeaderValues)>

Return an iterator over borrowed header names and header values. First yields the known headers and then the unknown headers, if any.

source

pub fn append(
 &mut self,
 name: impl Into<HeaderName<'static>>,
 value: impl Into<HeaderValues>
)

add the header value or header values into this header map. If there is already a header with the same name, the new values will be added to the existing ones. To replace any existing values, use Headers::insert

source

pub fn insert(
 &mut self,
 name: impl Into<HeaderName<'static>>,
 value: impl Into<HeaderValues>
)

Add a header value or header values into this header map. If a header already exists with the same name, it will be replaced. To combine, see Headers::append

source

pub fn try_insert(
 &mut self,
 name: impl Into<HeaderName<'static>>,
 value: impl Into<HeaderValues>
)

Add a header value or header values into this header map if and only if there is not already a header with the same name.

source

pub fn get_str<'a>(&'a self, name: impl Into<HeaderName<'a>>) -> Option<&'_ str>

Retrieves a &str header value if there is at least one header in the map with this name. If there are several headers with the same name, this follows the behavior defined at HeaderValues::one. Returns None if there is no header with the provided header name.

source

pub fn get<'a>(
&'a self,
name: impl Into<HeaderName<'a>>
) -> Option<&'_ HeaderValue>

Retrieves a singular header value from this header map. If there are several headers with the same name, this follows the behavior defined at HeaderValues::one. Returns None if there is no header with the provided header name

source

pub fn remove(
&mut self,
name: impl Into<HeaderName<'static>>
) -> Option<HeaderValues>

Takes all headers with the provided header name out of this header map and returns them. Returns None if the header did not have an entry in this map.

source

pub fn get_values<'a>(
&'a self,
name: impl Into<HeaderName<'a>>
) -> Option<&'_ HeaderValues>

Retrieves a reference to all header values with the provided header name. If you expect there to be only one value, use Headers::get.

source

pub fn has_header<'a>(&'a self, name: impl Into<HeaderName<'a>>) -> bool

Predicate function to check whether this header map contains the provided header name. If you are using this to conditionally insert a value, consider using Headers::try_insert instead.

source

pub fn eq_ignore_ascii_case<'a>(
 &'a self,
 name: impl Into<HeaderName<'a>>,
 needle: &str
) -> bool

Convenience function to check whether the value contained in this header map for the provided name is ascii-case-insensitively equal to the provided comparison &str. Returns false if there is no value for the name

source

pub fn contains_ignore_ascii_case<'a>(
 &'a self,
 name: impl Into<HeaderName<'a>>,
 needle: &str
) -> bool

Convenience function to check whether the value contained in this header map for the provided name. Prefer testing against a lower case string, as the implementation currently has to allocate if .