Struct HeaderBlock 

pub struct HeaderBlock { /* private fields */ }

An ordered, duplicate-preserving collection of HTTP headers.

Headers are stored as an ordered list of name/value pairs. Duplicate field names are preserved. Case-insensitive lookup by field name is provided.

Canonical representation

This type is normatively a list, not a map. Dictionary conversion (via Into<HashMap>) is lossy and should only be used as an explicit convenience.

Implementations

impl HeaderBlock

pub fn new() -> Self

Create an empty header block.

pub fn with_capacity(capacity: usize) -> Self

Create a header block with a pre-allocated capacity.

pub fn push(&mut self, name: HeaderName, value: HeaderValue)

Push a validated header field.

pub fn push_str( &mut self, name: impl Into<String>, value: impl Into<String>, ) -> Result<(), HeaderError>

Push a header field from string slices.

Errors

Returns HeaderError if the name or value is invalid.

pub fn get_first(&self, name: &str) -> Option<&HeaderValue>

Returns the first value for the given header name (case-insensitive).

pub fn get_all(&self, name: &str) -> Vec<&HeaderValue>

Returns all values for the given header name (case-insensitive), in order.

pub fn get_unique( &self, name: &str, ) -> Result<Option<&HeaderValue>, DuplicateHeaderError>

Returns the unique value for the given header name (case-insensitive).

Errors

Returns DuplicateHeaderError if the header appears more than once. Returns Ok(None) if the header is absent.

pub fn contains(&self, name: &str) -> bool

Returns true if a header with the given name exists (case-insensitive).

pub fn iter(&self) -> impl Iterator<Item = &HeaderField>

Returns an iterator over all header fields.

pub fn len(&self) -> usize

Returns the number of header fields.

pub fn is_empty(&self) -> bool

Returns true if there are no header fields.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&HeaderField) -> bool,

Retains only the elements specified by the predicate.

Trait Implementations

impl Clone for HeaderBlock

fn clone(&self) -> HeaderBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderBlock

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

Formats the value using the given formatter.

impl Default for HeaderBlock

fn default() -> HeaderBlock

Returns the “default value” for a type.

impl Display for HeaderBlock

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

Formats the value using the given formatter.

impl Eq for HeaderBlock

impl PartialEq for HeaderBlock

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HeaderBlock