Struct http_req::response::Headers

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

Wrapper around HashMap<Ascii, String> with additional functionality for parsing HTTP headers

Example

use http_req::response::Headers;

let mut headers = Headers::new();
headers.insert("Connection", "Close");

assert_eq!(headers.get("Connection"), Some(&"Close".to_string()))

Implementations

impl Headers

pub fn new() -> Headers

Creates an empty Headers.

The headers are initially created with a capacity of 0, so they will not allocate until it is first inserted into.

Examples

use http_req::response::Headers;

let mut headers = Headers::new();

pub fn with_capacity(capacity: usize) -> Headers

Creates empty Headers with the specified capacity.

The headers will be able to hold at least capacity elements without reallocating. If capacity is 0, the headers will not allocate.

Examples

use http_req::response::Headers;

let mut headers = Headers::with_capacity(200);

pub fn iter(&self) -> Iter<'_, Ascii<String>, String>

An iterator visiting all key-value pairs in arbitrary order. The iterator’s element type is (&Ascii, &String).

Examples

use http_req::response::Headers;

let mut headers = Headers::new();
headers.insert("Accept-Charset", "utf-8");
headers.insert("Accept-Language", "en-US");
headers.insert("Connection", "Close");

let mut iterator = headers.iter();

pub fn get<T: ToString + ?Sized>(&self, k: &T) -> Option<&String>

Returns a reference to the value corresponding to the key.

Examples

use http_req::response::Headers;

let mut headers = Headers::new();
headers.insert("Accept-Charset", "utf-8");

assert_eq!(headers.get("Accept-Charset"), Some(&"utf-8".to_string()))

pub fn insert<T, U>(&mut self, key: &T, val: &U) -> Option<String>

where T: ToString + ?Sized, U: ToString + ?Sized,

Inserts a key-value pair into the headers.

If the headers did not have this key present, None is returned.

If the headers did have this key present, the value is updated, and the old value is returned. The key is not updated, though; this matters for types that can be == without being identical.

Examples

use http_req::response::Headers;

let mut headers = Headers::new();
headers.insert("Accept-Language", "en-US");

pub fn default_http(uri: &Uri<'_>) -> Headers

Creates default headers for a HTTP request

Examples

use http_req::{response::Headers, uri::Uri};
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://www.rust-lang.org/learn").unwrap();
let headers = Headers::default_http(&uri);

Trait Implementations

impl Clone for Headers

fn clone(&self) -> Headers

Returns a copy 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 Display for Headers

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

Formats the value using the given formatter.

impl From<HashMap<Ascii<String>, String>> for Headers

fn from(map: HashMap<Ascii<String>, String>) -> Headers

Converts to this type from the input type.

impl From<Headers> for HashMap<Ascii<String>, String>

fn from(map: Headers) -> HashMap<Ascii<String>, String>

Converts to this type from the input type.

impl FromStr for Headers

type Err = ParseErr

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Headers, ParseErr>

Parses a string s to return a value of this type.

impl PartialEq for Headers

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

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

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

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

impl StructuralPartialEq for Headers