Struct HeaderMap 

pub struct HeaderMap { /* private fields */ }

A compact header map using SmallVec for inline storage.

Stores up to 12 headers inline (on the stack), only allocating on the heap if more headers are added.

Example

use armature_core::headers::HeaderMap;

let mut headers = HeaderMap::new();
headers.insert("Content-Type", "application/json");
headers.insert("Accept", "text/html");

assert_eq!(headers.get("content-type"), Some(&"application/json".to_string()));
assert!(headers.is_inline()); // Still on stack

Implementations

impl HeaderMap

pub const fn new() -> Self

Create a new empty header map.

pub fn with_capacity(capacity: usize) -> Self

Create with pre-allocated capacity.

If capacity <= INLINE_HEADERS, no heap allocation occurs.

pub fn is_inline(&self) -> bool

Check if storage is inline (no heap allocation).

pub fn len(&self) -> usize

Get the number of headers.

pub fn is_empty(&self) -> bool

Check if empty.

pub fn get(&self, name: &str) -> Option<&String>

Get header value by name (case-insensitive).

pub fn get_ignore_case(&self, name: &str) -> Option<&String>

Get header value by name, with lowercase fallback.

First tries exact match, then lowercase. This handles the common case where headers might be stored in different cases.

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

Check if header exists (case-insensitive).

pub fn insert( &mut self, name: impl Into<String>, value: impl Into<String>, ) -> Option<String>

Insert a header, replacing any existing header with same name.

Returns the old value if replaced.

pub fn append(&mut self, name: impl Into<String>, value: impl Into<String>)

Append a header (allows duplicates).

Unlike insert, this doesn’t replace existing headers. Use for headers that can have multiple values (e.g., Set-Cookie).

pub fn remove(&mut self, name: &str) -> Option<String>

Remove a header by name (case-insensitive).

Returns the removed value if found.

pub fn remove_all(&mut self, name: &str) -> usize

Remove all headers with given name (case-insensitive).

Returns number of headers removed.

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

Iterate over all headers.

pub fn names(&self) -> impl Iterator<Item = &String>

Iterate over header names.

pub fn values(&self) -> impl Iterator<Item = &String>

Iterate over header values.

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

Get all values for a header name (for multi-value headers).

pub fn clear(&mut self)

Clear all headers.

pub fn extend<I, K, V>(&mut self, iter: I)

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Extend with headers from iterator.

pub fn to_hash_map(&self) -> HashMap<String, String>

Convert to HashMap (for compatibility).

pub fn from_hash_map(map: HashMap<String, String>) -> Self

Create from HashMap.

pub fn content_type(&self) -> Option<&String>

Get Content-Type header.

pub fn content_length(&self) -> Option<usize>

Get Content-Length header as usize.

pub fn accept(&self) -> Option<&String>

Get Accept header.

pub fn authorization(&self) -> Option<&String>

Get Authorization header.

pub fn user_agent(&self) -> Option<&String>

Get User-Agent header.

pub fn host(&self) -> Option<&String>

Get Host header.

pub fn cookie(&self) -> Option<&String>

Get Cookie header.

pub fn is_keep_alive(&self) -> bool

Check if Keep-Alive connection.

pub fn is_chunked(&self) -> bool

Check if chunked transfer encoding.

pub fn set_content_type(&mut self, value: impl Into<String>)

Set Content-Type header.

pub fn set_content_length(&mut self, len: usize)

Set Content-Length header.

Trait Implementations

impl ArmatureHeaderMapExt for HeaderMap

fn to_http_headers(&self) -> HeaderMap

Convert to http::HeaderMap.

impl Clone for HeaderMap

fn clone(&self) -> HeaderMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderMap

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

Formats the value using the given formatter.

impl Default for HeaderMap

fn default() -> HeaderMap

Returns the “default value” for a type.

impl From<HashMap<String, String>> for HeaderMap

fn from(map: HashMap<String, String>) -> Self

Converts to this type from the input type.

impl From<HeaderMap> for HashMap<String, String>

fn from(map: HeaderMap) -> Self

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for HeaderMap

where K: Into<String>, V: Into<String>,

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl Index<&str> for HeaderMap

type Output = String

The returned type after indexing.

fn index(&self, name: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a HeaderMap

type Item = (&'a String, &'a String)

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, Header>, fn(&'a Header) -> (&'a String, &'a String)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for HeaderMap

type Item = (String, String)

The type of the elements being iterated over.

type IntoIter = Map<IntoIter<[Header; 12]>, fn(Header) -> (String, String)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.