Struct Headers 

pub struct Headers(/* private fields */);

A collection of headers.

Implementations

impl Headers

pub fn new() -> Headers

Create a new headers collection.

pub fn get<H>(&self) -> Result<H, Error>

where H: FromHeaders,

Gets the headers represented by H, or return an error if the header is not found.

pub fn get_optional<H>(&self) -> Result<Option<H>, <H as FromHeaders>::Error>

where H: FromHeaders,

Gets the headers represented by H, if they are present.

This method returns one of the following three values:

• Ok(Some(...)) if the relevant headers are present and could be parsed into the value.
• Ok(None) if the relevant headers are not present, so no attempt to parse them can be made.
• Err(...) if an error occurred when trying to parse the headers. This likely indicates that the headers are present but invalid.

pub fn get_optional_string(&self, key: &HeaderName) -> Option<String>

Optionally get a header value as a String.

pub fn get_str(&self, key: &HeaderName) -> Result<&str, Error>

Get a header value as a str, or err if it is not found.

pub fn get_optional_str(&self, key: &HeaderName) -> Option<&str>

Optionally get a header value as a str.

pub fn get_as<V, E>(&self, key: &HeaderName) -> Result<V, Error>

where V: FromStr<Err = E>, E: Error + Send + Sync + 'static,

Get a header value parsing it as the type, or err if it’s not found or it fails to parse.

pub fn get_optional_as<V, E>( &self, key: &HeaderName, ) -> Result<Option<V>, Error>

where V: FromStr<Err = E>, E: Error + Send + Sync + 'static,

Optionally get a header value parsing it as the type, or err if it fails to parse.

pub fn get_with<'a, V, F, E>( &'a self, key: &HeaderName, parser: F, ) -> Result<V, Error>

where F: FnOnce(&'a HeaderValue) -> Result<V, E>, E: Error + Send + Sync + 'static,

Get a header value using the parser, or err if it is not found or fails to parse.

pub fn get_optional_with<'a, V, F, E>( &'a self, key: &HeaderName, parser: F, ) -> Result<Option<V>, Error>

where F: FnOnce(&'a HeaderValue) -> Result<V, E>, E: Error + Send + Sync + 'static,

Optionally get a header value using the parser, or err if it fails to parse.

pub fn insert<K, V>(&mut self, key: K, value: V)

where K: Into<HeaderName>, V: Into<HeaderValue>,

Insert a header name/value pair.

pub fn add<H>(&mut self, header: H) -> Result<(), <H as AsHeaders>::Error>

where H: AsHeaders,

Add headers to the headers collection.

Errors

The error this returns depends on the type H. Many header types are infallible, return a Result with Infallible as the error type. In this case, you can safely .unwrap() the value without risking a panic.

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

Iterate over all the header name/value pairs.

pub fn remove<K>(&mut self, key: K) -> Option<HeaderValue>

where K: Into<HeaderName>,

Remove a header by name, returning the previous value if present.

Trait Implementations

impl Clone for Headers

fn clone(&self) -> Headers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Headers

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

Formats the value using the given formatter.

impl Default for Headers

fn default() -> Headers

Returns the “default value” for a type.

impl Eq for Headers

impl From<HashMap<HeaderName, HeaderValue>> for Headers

fn from(c: HashMap<HeaderName, HeaderValue>) -> Headers

Converts to this type from the input type.

impl IntoIterator for Headers

type Item = (HeaderName, HeaderValue)

The type of the elements being iterated over.

type IntoIter = IntoIter<HeaderName, HeaderValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Headers as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Headers

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

Equality operator ==.

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

Inequality operator !=.

impl Sanitizer for Headers

fn sanitize(&self, allowed_patterns: &HashSet<Cow<'static, str>>) -> String

Sanitizes a type by removing or masking sensitive information based on a set of allowed patterns

impl StructuralPartialEq for Headers