Struct HeaderMap

Source

pub struct HeaderMap { /* private fields */ }

Expand description

A compact header map using SmallVec for inline storage.

§Example

use armature_core::headers::HeaderMap;

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

// Lookup is case-insensitive; the value comes back as a `&str`.
assert_eq!(headers.get("content-type"), Some("application/json"));
assert!(headers.is_inline()); // Still on stack

Implementations§

Source §

impl HeaderMap

Source

pub const fn new() -> Self

Create a new empty header map.

Source

pub fn with_capacity(capacity: usize) -> Self

Create with pre-allocated capacity.

If capacity <= INLINE_HEADERS, no heap allocation occurs.

Source

pub fn is_inline(&self) -> bool

Check if storage is inline (no heap allocation).

Source

pub fn len(&self) -> usize

Get the number of headers.

Source

pub fn is_empty(&self) -> bool

Check if empty.

Source

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

The value of name as UTF-8, case-insensitively.

Returns None for a value that is not valid UTF-8; use HeaderMap::get_bytes for those.

Source

pub fn get_bytes(&self, name: &str) -> Option<&Bytes>

The raw value of name, case-insensitively.

Source

pub fn get_id(&self, id: &HeaderId) -> Option<&Bytes>

The raw value for an already-interned name.

The hot-path accessor: no interning, and for a well-known name the comparison is on the enum discriminant.

Source

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

The value of name as UTF-8, case-insensitively.

Identical to HeaderMap::get; kept because call sites use both names.

Source

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

Check if header exists (case-insensitive).

Source

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

Check if header exists (case-insensitive).

HashMap-compatible alias for contains.

Source

pub fn insert( &mut self, name: impl AsRef<str>, value: impl HeaderValueInput, ) -> Option<Bytes>

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

Returns the old value if one was replaced.

Source

pub fn append(&mut self, name: impl AsRef<str>, value: impl HeaderValueInput)

Append a header, allowing duplicates.

Unlike insert, this does not replace. Use it for fields that may repeat, such as Set-Cookie.

Source

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

Remove a header by name (case-insensitive), returning its value.

Source

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

Remove every header with the given name, returning how many were removed.

Source

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

Iterate over headers as (name, value), skipping non-UTF-8 values.

Source

pub fn iter_raw(&self) -> impl Iterator<Item = (&HeaderId, &Bytes)>

Iterate over every header, including those with non-UTF-8 values.

Source

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

Iterate over header names, lowercased.

Source

pub fn keys(&self) -> impl Iterator<Item = &str>

Iterate over header names.

HashMap-compatible alias for names.

Source

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

Iterate over header values, skipping non-UTF-8 ones.

Source

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

Every value for a header name, for multi-value fields.

Source

pub fn clear(&mut self)

Clear all headers.

Source

pub fn extend<I, K, V>(&mut self, iter: I)
where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: HeaderValueInput,

Extend with headers from an iterator.

Source

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

Convert to a HashMap, for compatibility.

Names come out lowercased and non-UTF-8 values are dropped. This allocates a String per name and value — reach for it only when a HashMap is genuinely required.

Source