Expand description
Headers container, and common header fields.
hyper has the opinion that Headers should be strongly-typed, because that’s
why we’re using Rust in the first place. To set or get any header, an object
must implement the Header trait from this module. Several common headers
are already provided, such as Host, ContentType, UserAgent, and others.
Why Typed?
Or, why not stringly-typed? Types give the following advantages:
- More difficult to typo, since typos in types should be caught by the compiler
- Parsing to a proper type by default
Defining Custom Headers
Hyper provides many of the most commonly used headers in HTTP. If
you need to define a custom header, it’s easy to do while still taking
advantage of the type system. Hyper includes a header! macro for defining
many wrapper-style headers.
#[macro_use] extern crate hyperx;
use hyperx::header::Headers;
header! { (XRequestGuid, "X-Request-Guid") => [String] }
fn main () {
let mut headers = Headers::new();
headers.set(XRequestGuid("a proper guid".to_owned()))
}This works well for simple “string” headers. If you need more control, you can implement the trait directly.
Implementing the Header trait
Consider a Do Not Track header. It can be true or false, but it represents
that via the numerals 1 and 0.
use std::fmt;
use hyperx::header::{self, Header, Raw};
#[derive(Debug, Clone, Copy)]
struct Dnt(bool);
impl Header for Dnt {
fn header_name() -> &'static str {
"DNT"
}
fn parse_header(raw: &Raw) -> hyperx::Result<Dnt> {
if raw.len() == 1 {
let line = &raw[0];
if line.len() == 1 {
let byte = line[0];
match byte {
b'0' => return Ok(Dnt(true)),
b'1' => return Ok(Dnt(false)),
_ => ()
}
}
}
Err(hyperx::Error::Header)
}
fn fmt_header(&self, f: &mut header::Formatter) -> fmt::Result {
let value = if self.0 {
"1"
} else {
"0"
};
f.fmt_line(&value)
}
}Modules
Utility functions for Header implementations.
Macros
Structs
Accept-Charset header, defined in
RFC7231Accept-Encoding header, defined in
RFC7231Accept-Language header, defined in
RFC7231Accept-Ranges header, defined in
RFC7233Access-Control-Allow-Credentials header, part of
CORSAccess-Control-Allow-Headers header, part of
CORSAccess-Control-Allow-Methods header, part of
CORSAccess-Control-Expose-Headers header, part of
CORSAccess-Control-Max-Age header, part of
CORSAccess-Control-Request-Headers header, part of
CORSAccess-Control-Request-Method header, part of
CORSAuthorization header, defined in RFC7235Credential holder for Basic Authentication
Token holder for Bearer Authentication, most often seen with oauth
Cache-Control header, defined in RFC7234Connection header, defined in
RFC7230A
Content-Disposition header, (re)defined in RFC6266.Content-Encoding header, defined in
RFC7231Content-Language header, defined in
RFC7231Content-Length header, defined in
RFC7230Content-Location header, defined in
RFC7231Content-Range header, defined in
RFC7233Content-Type header, defined in
RFC7231Iterator for cookie.
A formatter used to serialize headers to an output stream.
Returned with the
HeadersItems iterator.A map of header fields on requests and responses.
An
Iterator over the fields in a Headers map.The
Host header.A timestamp with HTTP formatting and parsing
If-Modified-Since header, defined in
RFC7232If-Unmodified-Since header, defined in
RFC7232A language tag as described in BCP47.
Last-Event-ID header, defined in
RFC3864Last-Modified header, defined in
RFC7232The
Origin header.Preference-Applied header, defined in RFC7240Protocols that appear in the
Upgrade header fieldProxy-Authorization header, defined in RFC7235Represents a quality used in quality values.
Represents an item with a quality value as defined in
RFC7231.
A raw header value.
StrictTransportSecurity header, defined in RFC6797Transfer-Encoding header, defined in
RFC7230Enums
The
Access-Control-Allow-Origin response header,
part of CORSEach
Range::Bytes header can contain one or more ByteRangeSpecs.
Each ByteRangeSpec defines a range of bytes to fetchCacheControl contains a list of these directives.A Mime charset.
Values that can be in the
Connection header.Content-Range, described in RFC7233
A parameter to the disposition type.
The implied disposition of the content of the HTTP body.
A value to represent an encoding used in
Transfer-Encoding
or Accept-Encoding header.The
Expect header.If-None-Match header, defined in
RFC7232A Media Descriptors Enum based on:
https://www.w3.org/TR/html401/types.html#h-6.13
The
Pragma header defined by HTTP/1.0.Prefer contains a list of these preferences.
A protocol name used to identify a specific protocol. Names are case-sensitive
except for the
WebSocket value.Referrer-Policy header, part of
Referrer PolicyA Link Relation Type Enum based on:
RFC5988
The
Retry-After header.Traits
A trait for any object that will represent a header field and value.
An Authorization scheme to be used in the header.