Struct rocket::http::HeaderMap

pub struct HeaderMap<'h> { /* fields omitted */ }

A collection of headers, mapping a header name to its many ordered values.

Case-Insensitivity

All header names, including those passed in to HeaderMap methods and those stored in an existing HeaderMap, are treated case-insensitively. This means that, for instance, a look for a header by the name of "aBC" will returns values for headers of names "AbC", "ABC", "abc", and so on.

Methods

impl<'h> HeaderMap<'h>

pub fn new() -> HeaderMap<'h>

Returns an empty header collection.

Example

use rocket::http::HeaderMap;

let map = HeaderMap::new();

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

Returns true if self contains a header with the name name.

Example

use rocket::http::{HeaderMap, ContentType};

let mut map = HeaderMap::new();
map.add(ContentType::HTML);

assert!(map.contains("Content-Type"));
assert!(!map.contains("Accepts"));

pub fn len(&self) -> usize

Returns the number of values stored in the map.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();
assert_eq!(map.len(), 0);

map.add_raw("X-Custom", "value_1");
assert_eq!(map.len(), 1);

map.replace_raw("X-Custom", "value_2");
assert_eq!(map.len(), 1);

map.add_raw("X-Custom", "value_1");
assert_eq!(map.len(), 2);

pub fn is_empty(&self) -> bool

Returns true if there are no headers stored in the map. Otherwise returns false.

Example

use rocket::http::HeaderMap;

let map = HeaderMap::new();
assert!(map.is_empty());

pub fn get(&'a self, name: &str) -> impl Iterator<Item = &'a str>

Returns an iterator over all of the values stored in self for the header with name name. The headers are returned in FIFO order.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();
map.add_raw("X-Custom", "value_1");
map.add_raw("X-Custom", "value_2");

assert_eq!(map.len(), 2);

let mut values = map.get("X-Custom");
assert_eq!(values.next(), Some("value_1"));
assert_eq!(values.next(), Some("value_2"));
assert_eq!(values.next(), None);

pub fn get_one(&'a self, name: &str) -> Option<&'a str>

Returns the first value stored for the header with name name if there is one.

Examples

Retrieve the first value when one exists:

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();
map.add_raw("X-Custom", "value_1");
map.add_raw("X-Custom", "value_2");

assert_eq!(map.len(), 2);

let first_value = map.get_one("X-Custom");
assert_eq!(first_value, Some("value_1"));

Attempt to retrieve a value that doesn't exist:

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();
map.add_raw("X-Custom", "value_1");

let first_value = map.get_one("X-Other");
assert_eq!(first_value, None);

pub fn replace<'p, H>(&mut self, header: H) -> bool where
    'p: 'h,
    H: Into<Header<'p>>, 

Replace any header that matches the name of header.name with header. If there is no such header in self, add header. If the matching header had multiple values, all of the values are removed, and only the value in header will remain.

Example

Replace a header that doesn't yet exist:

use rocket::http::{HeaderMap, ContentType};

let mut map = HeaderMap::new();
map.replace(ContentType::JSON);

assert!(map.get_one("Content-Type").is_some());

Replace a header that already exists:

use rocket::http::{HeaderMap, ContentType};

let mut map = HeaderMap::new();

map.replace(ContentType::JSON);
assert_eq!(map.get_one("Content-Type"), Some("application/json"));

map.replace(ContentType::GIF);
assert_eq!(map.get_one("Content-Type"), Some("image/gif"));
assert_eq!(map.len(), 1);

An example of case-insensitivity.

use rocket::http::{HeaderMap, Header, ContentType};

let mut map = HeaderMap::new();

map.replace(ContentType::JSON);
assert_eq!(map.get_one("Content-Type"), Some("application/json"));

map.replace(Header::new("CONTENT-type", "image/gif"));
assert_eq!(map.get_one("Content-Type"), Some("image/gif"));
assert_eq!(map.len(), 1);

pub fn replace_raw<'a, 'b, N, V>(&mut self, name: N, value: V) -> bool where
    'a: 'h,
    'b: 'h,
    N: Into<Cow<'a, str>>,
    V: Into<Cow<'b, str>>, 

A convenience method to replace a header using a raw name and value. Aliases replace(Header::new(name, value)). Should be used rarely.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();

map.replace_raw("X-Custom", "value_1");
assert_eq!(map.get_one("X-Custom"), Some("value_1"));

map.replace_raw("X-Custom", "value_2");
assert_eq!(map.get_one("X-Custom"), Some("value_2"));
assert_eq!(map.len(), 1);

pub fn replace_all<'n, 'v, H>(&mut self, name: H, values: Vec<Cow<'v, str>>) where
    'v: 'h,
    'n: 'h,
    H: Into<Cow<'n, str>>, 

Replaces all of the values for a header with name name with values. This a low-level method and should rarely be used.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();
map.add_raw("X-Custom", "value_1");
map.add_raw("X-Custom", "value_2");

let vals: Vec<_> = map.get("X-Custom").map(|s| s.to_string()).collect();
assert_eq!(vals, vec!["value_1", "value_2"]);

map.replace_all("X-Custom", vec!["value_3".into(), "value_4".into()]);
let vals: Vec<_> = map.get("X-Custom").collect();
assert_eq!(vals, vec!["value_3", "value_4"]);

pub fn add<'p, H>(&mut self, header: H) where
    'p: 'h,
    H: Into<Header<'p>>, 

Adds header into the map. If a header with header.name was previously added, that header will have one more value.

use rocket::http::{Cookie, HeaderMap};

let mut map = HeaderMap::new();

map.add(&Cookie::new("a", "b"));
assert_eq!(map.get("Set-Cookie").count(), 1);

map.add(&Cookie::new("c", "d"));
assert_eq!(map.get("Set-Cookie").count(), 2);

pub fn add_raw<'a, 'b, N, V>(&mut self, name: N, value: V) where
    'a: 'h,
    'b: 'h,
    N: Into<Cow<'a, str>>,
    V: Into<Cow<'b, str>>, 

A convenience method to add a header using a raw name and value. Aliases add(Header::new(name, value)). Should be used rarely.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();

map.add_raw("X-Custom", "value_1");
assert_eq!(map.get("X-Custom").count(), 1);

map.add_raw("X-Custom", "value_2");
let values: Vec<_> = map.get("X-Custom").collect();
assert_eq!(values, vec!["value_1", "value_2"]);

pub fn add_all<'n, H>(&mut self, name: H, values: &mut Vec<Cow<'h, str>>) where
    'n: 'h,
    H: Into<Cow<'n, str>>, 

Adds all of the values to a header with name name. This a low-level method and should rarely be used. values will be empty when this method returns.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();

let mut values = vec!["value_1".into(), "value_2".into()];
map.add_all("X-Custom", &mut values);
assert_eq!(map.get("X-Custom").count(), 2);
assert_eq!(values.len(), 0);

let mut values = vec!["value_3".into(), "value_4".into()];
map.add_all("X-Custom", &mut values);
assert_eq!(map.get("X-Custom").count(), 4);
assert_eq!(values.len(), 0);

let values: Vec<_> = map.get("X-Custom").collect();
assert_eq!(values, vec!["value_1", "value_2", "value_3", "value_4"]);

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

Remove all of the values for header with name name.

Example

use rocket::http::HeaderMap;

let mut map = HeaderMap::new();
map.add_raw("X-Custom", "value_1");
map.add_raw("X-Custom", "value_2");
map.add_raw("X-Other", "other");

assert_eq!(map.len(), 3);

map.remove("X-Custom");
assert_eq!(map.len(), 1);

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn remove_all(&mut self) -> Vec<Header<'h>>

Removes all of the headers stored in this map and returns a vector containing them. Header names are returned in no specific order, but all values for a given header name are grouped together, and values are in FIFO order.

Example

use rocket::http::{HeaderMap, Header};
use std::collections::HashSet;

// The headers we'll be storing.
let all_headers = vec![
    Header::new("X-Custom", "value_1"),
    Header::new("X-Custom", "value_2"),
    Header::new("X-Other", "other")
];

// Create a map, store all of the headers.
let mut map = HeaderMap::new();
for header in all_headers.clone() {
    map.add(header)
}

assert_eq!(map.len(), 3);

// Now remove them all, ensure the map is empty.
let removed_headers = map.remove_all();
assert!(map.is_empty());

// Create two sets: what we expect and got. Ensure they're equal.
let expected_set: HashSet<_> = all_headers.into_iter().collect();
let actual_set: HashSet<_> = removed_headers.into_iter().collect();
assert_eq!(expected_set, actual_set);

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

Returns an iterator over all of the Headers stored in the map. Header names are returned in no specific order, but all values for a given header name are grouped together, and values are in FIFO order.

Example

use rocket::http::{HeaderMap, Header};

// The headers we'll be storing.
let all_headers = vec![
    Header::new("X-Custom", "value_1"),
    Header::new("X-Other", "other"),
    Header::new("X-Third", "third"),
];

// Create a map, store all of the headers.
let mut map = HeaderMap::new();
for header in all_headers {
    map.add(header)
}

// Ensure there are three headers via the iterator.
assert_eq!(map.iter().count(), 3);

// Actually iterate through them.
for header in map.iter() {
    match header.name() {
        "X-Custom" => assert_eq!(header.value(), "value_1"),
        "X-Other" => assert_eq!(header.value(), "other"),
        "X-Third" => assert_eq!(header.value(), "third"),
        _ => unreachable!("there are only three headers")
    }
}

pub fn into_iter(self) -> impl Iterator<Item = Header<'h>>

Consumes self and returns an iterator over all of the Headers stored in the map. Header names are returned in no specific order, but all values for a given header name are grouped together, and values are in FIFO order.

Example

use rocket::http::{HeaderMap, Header};

// The headers we'll be storing.
let all_headers = vec![
    Header::new("X-Custom", "value_1"),
    Header::new("X-Other", "other"),
    Header::new("X-Third", "third"),
];

// Create a map, store all of the headers.
let mut map = HeaderMap::new();
for header in all_headers {
    map.add(header)
}

// Ensure there are three headers via the iterator.
assert_eq!(map.iter().count(), 3);

// Actually iterate through them.
for header in map.into_iter() {
    match header.name() {
        "X-Custom" => assert_eq!(header.value(), "value_1"),
        "X-Other" => assert_eq!(header.value(), "other"),
        "X-Third" => assert_eq!(header.value(), "third"),
        _ => unreachable!("there are only three headers")
    }
}

Trait Implementations

impl<'h> PartialEq<HeaderMap<'h>> for HeaderMap<'h>

fn eq(&self, other: &HeaderMap<'h>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HeaderMap<'h>) -> bool

This method tests for !=.

impl<'h> Clone for HeaderMap<'h>

fn clone(&self) -> HeaderMap<'h>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'h> Debug for HeaderMap<'h>

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

Formats the value using the given formatter.

impl<'h> Default for HeaderMap<'h>

fn default() -> HeaderMap<'h>

Returns the "default value" for a type.