Struct RequestHeaders 

pub struct RequestHeaders { /* private fields */ }

A case-insensitive collection of HTTP request headers.

RequestHeaders wraps Hyper’s HeaderMap to provide a convenient API for working with HTTP headers without unnecessary allocations.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.insert("Content-Type", "application/json");
headers.append("Set-Cookie", "id=123");
headers.append("Set-Cookie", "theme=dark");

assert_eq!(headers.content_type(), Some("application/json"));
assert_eq!(headers.get_all("set-cookie").len(), 2);

Implementations

impl RequestHeaders

pub fn new() -> Self

Creates a new, empty RequestHeaders collection.

Example

use ripress::req::request_headers::RequestHeaders;

let headers = RequestHeaders::new();
assert!(headers.is_empty());

pub fn insert<K, V>(&mut self, key: K, value: V)

where K: AsRef<str>, V: AsRef<str>,

Inserts a header value, replacing any existing values for the header name.

Header names are case-insensitive.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.insert("Content-Type", "application/json");
assert_eq!(headers.content_type(), Some("application/json"));

pub fn append<K, V>(&mut self, key: K, value: V)

where K: AsRef<str>, V: AsRef<str>,

Appends a value to an existing header or creates it if not present.

Useful for headers that allow multiple values, such as Set-Cookie or Accept.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.append("Set-Cookie", "id=1");
headers.append("Set-Cookie", "theme=dark");
assert_eq!(headers.get_all("Set-Cookie").len(), 2);

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

where K: AsRef<str>,

Returns the first value for the given header name, if present.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.append("Accept", "application/json");
headers.append("Accept", "text/html");
assert_eq!(headers.get("Accept"), Some("application/json"));

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

where K: AsRef<str>,

Returns all values for the given header name.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.append("Accept", "application/json");
headers.append("Accept", "text/html");
assert_eq!(headers.get_all("Accept").len(), 2);

pub fn contains_key<K>(&self, key: K) -> bool

where K: AsRef<str>,

Checks whether a header exists.

pub fn remove<K>(&mut self, key: K) -> Option<String>

where K: AsRef<str>,

Removes a header entirely, returning its first value if present.

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

Returns the value of the Content-Type header, if present.

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

Returns the value of the Authorization header, if present.

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

Returns the value of the User-Agent header, if present.

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

Returns the value of the Accept header, if present.

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

Returns the value of the Host header, if present.

pub fn x_forwarded_for(&self) -> Option<&str>

Returns the value of the X-Forwarded-For header, if present.

This can be useful for retrieving the real IP address of a client behind proxies.

pub fn accepts_json(&self) -> bool

Returns true if the Accept header indicates the client accepts JSON.

Matches if the Accept header contains application/json or */*.

pub fn accepts_html(&self) -> bool

Returns true if the Accept header indicates the client accepts HTML.

Matches if the Accept header contains text/html or */*.

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

Returns an iterator over all header names.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.insert("Content-Type", "application/json");
for key in headers.keys() {
    println!("{}", key);
}

pub fn len(&self) -> usize

Returns the number of unique header names.

pub fn is_empty(&self) -> bool

Returns true if there are no headers.

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

Iterates over all headers as (name, first_value) pairs.

Useful when you only need the first value for each header.

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

Iterates over all headers as (name, value) pairs, including duplicates.

pub fn as_header_map(&self) -> &HeaderMap

Returns a reference to the inner HeaderMap for advanced usage.

pub fn into_header_map(self) -> HeaderMap

Consumes self and returns the inner HeaderMap.

Trait Implementations

impl Clone for RequestHeaders

fn clone(&self) -> RequestHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestHeaders

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

Formats the value using the given formatter.

impl Default for RequestHeaders

fn default() -> Self

Returns the “default value” for a type.

impl Display for RequestHeaders

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

Formats the headers as key: value lines.

Example

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.insert("Content-Type", "application/json");
println!("{}", headers);

impl From<HeaderMap> for RequestHeaders

fn from(map: HeaderMap) -> Self

Converts to this type from the input type.

impl From<RequestHeaders> for HeaderMap

fn from(headers: RequestHeaders) -> Self

Converts to this type from the input type.

impl Index<&str> for RequestHeaders

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

Provides convenient indexing syntax:

use ripress::req::request_headers::RequestHeaders;

let mut headers = RequestHeaders::new();
headers.insert("Content-Type", "application/json");
assert_eq!(&headers["content-type"], "application/json");

Panics

Panics if the header does not exist.

type Output = str

The returned type after indexing.