Struct Headers 

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

A list of key-value pairs representing HTTP headers.

// Prepares a new Headers instance with a specified capacity
let mut headers = Headers::with_capacity(2);
headers.add("Content-Type", "text/plain");
headers.add("Authorization", "Bearer token");

assert_eq!(headers.len(), 2);
assert_eq!(headers.first("Content-Type"), Some("text/plain"));

// Supports iterating over headers for updates
for header in headers.iter_mut() {
    if header.key.eq_ignore_ascii_case("Authorization") {
        header.value = String::from("SECRET");
    }
}

// Key lookup is case-insensitive
assert_eq!(headers.first("authorization"), Some("SECRET"));

// Accessing headers by index
assert_eq!(headers[0].key, "Content-Type");
assert_eq!(headers[0].value, "text/plain");

// Creates a Headers instance from an iterator of tuples
let headers = Headers::from_iter([
    ("X-Custom-Header", "value1"),
    ("X-Another-Header", "value2")
]);

assert_eq!(headers.first("x-custom-header"), Some("value1"));
assert_eq!(headers.first("x-another-header"), Some("value2"));

---

Implementations

impl Headers

pub fn with_capacity(capacity: usize) -> Self

Prepares a new Headers instance with a specified capacity.

pub fn values_for(&self, key: &str) -> impl Iterator<Item = &str>

Provides an iterator over all header values for a given key.

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

Provides the first value for a given key, if it exists.

pub fn add(&mut self, key: &str, value: &str)

Adds a new header line with the specified key and value.

pub fn insert_many<I, T>(&mut self, iter: I)

where I: IntoIterator<Item = T>, T: Into<HeaderLine>,

Adds a new header line from a tuple of key and value.

pub fn is_empty(&self) -> bool

Tests if the headers collection is empty.

pub fn len(&self) -> usize

Returns the number of headers in the collection.

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

Reference iterator for the headers collection.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut HeaderLine>

Mutable reference iterator for the headers collection.

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

Formats the value using the given formatter.

impl Default for Headers

fn default() -> Headers

Returns the “default value” for a type.

impl<T> FromIterator<T> for Headers

where T: Into<HeaderLine>,

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl Index<&str> for Headers

type Output = HeaderLine

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Headers

type Output = HeaderLine

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Headers

type Item = &'a HeaderLine

The type of the elements being iterated over.

type IntoIter = Iter<'a, HeaderLine>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Headers

type Item = HeaderLine

The type of the elements being iterated over.

type IntoIter = IntoIter<HeaderLine>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Headers

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Headers

impl StructuralPartialEq for Headers