Struct Headers 

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

Request or response headers.

A thin wrapper around http::HeaderMap that adds provider-oriented helpers: overriding merge, user-agent suffixing and masking of sensitive values in diagnostic output. Debug and Serialize never reveal authorization, API-key or cookie values.

Implementations

impl Headers

pub fn new() -> Self

Creates an empty header map.

pub fn from_map(map: HeaderMap) -> Self

Wraps an existing HeaderMap.

pub fn as_map(&self) -> &HeaderMap

Returns the wrapped HeaderMap.

pub fn as_map_mut(&mut self) -> &mut HeaderMap

Returns the wrapped HeaderMap mutably.

pub fn into_map(self) -> HeaderMap

Consumes the wrapper and returns the HeaderMap.

pub fn is_empty(&self) -> bool

Returns true when no header is present.

pub fn len(&self) -> usize

Returns the number of header entries (repeated names count once each).

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

Returns the first value of name as a string, if present and ASCII.

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

Returns true when name is present.

pub fn insert(&mut self, name: &str, value: &str) -> Result<(), InvalidHeader>

Inserts a header, replacing existing values with the same name.

Returns an error when the name or value is not a valid header.

Errors

Returns InvalidHeader when name is not a valid header name or value contains characters not allowed in header values.

pub fn with(self, name: &str, value: &str) -> Self

Builder-style Headers::insert; invalid pairs are skipped silently.

Intended for static configuration where the caller controls the values; use Headers::insert for untrusted input.

pub fn remove(&mut self, name: &str)

Removes all values for name.

pub fn merge(&mut self, other: &Headers)

Merges other into self; values in other override existing ones.

Repeated header names in other replace all existing values of that name, mirroring “later headers win” semantics for configuration layering (provider defaults, per-model settings, per-call headers).

pub fn merged(self, other: &Headers) -> Self

Returns a copy with other merged on top; see Headers::merge.

pub fn merge_pairs<'a, I>(&mut self, pairs: I)

where I: IntoIterator<Item = (&'a str, Option<&'a str>)>,

Merges optional string pairs; pairs whose value is None are skipped.

Invalid names or values are skipped as well; this mirrors the lenient behaviour needed when layering user-supplied header maps.

pub fn with_user_agent_suffix<'a, I>(self, suffixes: I) -> Self

where I: IntoIterator<Item = &'a str>,

Appends suffixes to the user-agent header, creating it if absent.

Existing user-agent text is kept and each suffix is separated by a single space. Empty suffixes are ignored.

pub fn iter_str(&self) -> impl Iterator<Item = (&str, String)> + '_

Iterates over (name, value) pairs with values rendered as strings.

Non-ASCII values are rendered lossily; sensitive values are not masked.

pub fn masked(&self) -> Headers

Returns a copy with sensitive values replaced by ***.

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<'de> Deserialize<'de> for Headers

Deserializes from an object of name -> value pairs; invalid entries are rejected with an error.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for Headers

impl From<HeaderMap> for Headers

fn from(map: HeaderMap) -> Self

Converts to this type from the input type.

impl From<Headers> for HeaderMap

fn from(headers: Headers) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Headers

type Item = (&'a HeaderName, &'a HeaderValue)

The type of the elements being iterated over.

type IntoIter = Iter<'a, HeaderValue>

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Headers

Serializes as an object of name -> value pairs with sensitive values masked. Repeated header names are joined with ", ".

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Headers