refactor(headers): Improve docs, fix nits, make formatting faster

src/header/parsing.rs now uses unsafe get_unchecked() again, I don't
know why it was removed.

Author: pyfisch

src/header/common/access_control_allow_headers.rs

@@ -2,7 +2,7 @@ use unicase::UniCase;
 
 header! {
     #[doc="`Access-Control-Allow-Headers` header, part of"]
-    #[doc="[CORS](www.w3.org/TR/cors/#access-control-allow-headers-response-header)"]
+    #[doc="[CORS](http://www.w3.org/TR/cors/#access-control-allow-headers-response-header)"]
     #[doc=""]
     #[doc="The `Access-Control-Allow-Headers` header indicates, as part of the"]
     #[doc="response to a preflight request, which header field names can be used"]

src/header/common/access_control_allow_methods.rs

@@ -2,7 +2,7 @@ use method::Method;
 
 header! {
     #[doc="`Access-Control-Allow-Methods` header, part of"]
-    #[doc="[CORS](www.w3.org/TR/cors/#access-control-allow-methods-response-header)"]
+    #[doc="[CORS](http://www.w3.org/TR/cors/#access-control-allow-methods-response-header)"]
     #[doc=""]
     #[doc="The `Access-Control-Allow-Methods` header indicates, as part of the"]
     #[doc="response to a preflight request, which methods can be used during the"]

src/header/common/access_control_max_age.rs

@@ -1,6 +1,6 @@
 header! {
     #[doc="`Access-Control-Max-Age` header, part of"]
-    #[doc="[CORS](www.w3.org/TR/cors/#access-control-max-age-response-header)"]
+    #[doc="[CORS](http://www.w3.org/TR/cors/#access-control-max-age-response-header)"]
     #[doc=""]
     #[doc="The `Access-Control-Max-Age` header indicates how long the results of a"]
     #[doc="preflight request can be cached in a preflight result cache."]

src/header/common/access_control_request_headers.rs

@@ -2,7 +2,7 @@ use unicase::UniCase;
 
 header! {
     #[doc="`Access-Control-Request-Headers` header, part of"]
-    #[doc="[CORS](www.w3.org/TR/cors/#access-control-request-headers-request-header)"]
+    #[doc="[CORS](http://www.w3.org/TR/cors/#access-control-request-headers-request-header)"]
     #[doc=""]
     #[doc="The `Access-Control-Request-Headers` header indicates which headers will"]
     #[doc="be used in the actual request as part of the preflight request."]

src/header/common/access_control_request_method.rs

@@ -2,7 +2,7 @@ use method::Method;
 
 header! {
     #[doc="`Access-Control-Request-Method` header, part of"]
-    #[doc="[CORS](www.w3.org/TR/cors/#access-control-request-method-request-header)"]
+    #[doc="[CORS](http://www.w3.org/TR/cors/#access-control-request-method-request-header)"]
     #[doc=""]
     #[doc="The `Access-Control-Request-Method` header indicates which method will be"]
     #[doc="used in the actual request as part of the preflight request."]

src/header/common/authorization.rs

@@ -1,11 +1,25 @@
 use std::any::Any;
-use std::fmt;
+use std::fmt::{self, Display};
 use std::str::{FromStr, from_utf8};
 use std::ops::{Deref, DerefMut};
 use serialize::base64::{ToBase64, FromBase64, Standard, Config, Newline};
 use header::{Header, HeaderFormat};
 
-/// The `Authorization` header field.
+/// `Authorization` header, defined in [RFC7235](https://tools.ietf.org/html/rfc7235#section-4.2)
+///
+/// The `Authorization` header field allows a user agent to authenticate
+/// itself with an origin server -- usually, but not necessarily, after
+/// receiving a 401 (Unauthorized) response.  Its value consists of
+/// credentials containing the authentication information of the user
+/// agent for the realm of the resource being requested.
+///
+/// # ABNF
+/// ```plain
+/// Authorization = credentials
+/// ```
+///
+/// # Example values
+/// * `Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==`
 #[derive(Clone, PartialEq, Debug)]
 pub struct Authorization<S: Scheme>(pub S);
 
@@ -69,7 +83,7 @@ impl Scheme for String {
     }
 
     fn fmt_scheme(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        fmt::Display::fmt(self, f)
+        Display::fmt(self, f)
     }
 }
 
@@ -97,12 +111,12 @@ impl Scheme for Basic {
         if let Some(ref pass) = self.password {
             text.push_str(&pass[..]);
         }
-        write!(f, "{}", text.as_bytes().to_base64(Config {
+        f.write_str(&text.as_bytes().to_base64(Config {
             char_set: Standard,
             newline: Newline::CRLF,
             pad: true,
             line_length: None
-        }))
+        })[..])
     }
 }
 

src/header/common/cache_control.rs

@@ -3,7 +3,23 @@ use std::str::FromStr;
 use header::{Header, HeaderFormat};
 use header::parsing::{from_one_comma_delimited, fmt_comma_delimited};
 
-/// The Cache-Control header.
+/// `Cache-Control` header, defined in [RFC7234](https://tools.ietf.org/html/rfc7234#section-5.2)
+///
+/// The `Cache-Control` header field is used to specify directives for
+/// caches along the request/response chain.  Such cache directives are
+/// unidirectional in that the presence of a directive in a request does
+/// not imply that the same directive is to be given in the response.
+///
+/// # ABNF
+/// ```plain
+/// Cache-Control   = 1#cache-directive
+/// cache-directive = token [ "=" ( token / quoted-string ) ]
+/// ```
+///
+/// # Example values
+/// * `no-cache`
+/// * `private, community="UCI"`
+/// * `max-age=30`
 #[derive(PartialEq, Clone, Debug)]
 pub struct CacheControl(pub Vec<CacheDirective>);
 
@@ -28,8 +44,8 @@ impl Header for CacheControl {
 }
 
 impl HeaderFormat for CacheControl {
-    fn fmt_header(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
-        fmt_comma_delimited(fmt, &self[..])
+    fn fmt_header(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        fmt_comma_delimited(f, &self[..])
     }
 }
 

src/header/common/connection.rs

@@ -1,12 +1,29 @@
 use header::{Header, HeaderFormat};
-use std::fmt;
+use std::fmt::{self, Display};
 use std::str::FromStr;
 use header::parsing::{from_comma_delimited, fmt_comma_delimited};
 use unicase::UniCase;
 
 pub use self::ConnectionOption::{KeepAlive, Close, ConnectionHeader};
 
-/// The `Connection` header.
+/// `Connection` header, defined in [RFC7230](https://tools.ietf.org/html/rfc7230#section-6.1)
+///
+/// The `Connection` header field allows the sender to indicate desired
+/// control options for the current connection.  In order to avoid
+/// confusing downstream recipients, a proxy or gateway MUST remove or
+/// replace any received connection options before forwarding the
+/// message.
+///
+/// # ABNF
+/// ```plain
+/// Connection        = 1#connection-option
+/// connection-option = token
+/// ```
+///
+/// # Example values
+/// * `close`
+/// * `upgrade`
+/// * `keep-alive`
 #[derive(Clone, PartialEq, Debug)]
 pub struct Connection(pub Vec<ConnectionOption>);
 
@@ -33,20 +50,20 @@ pub enum ConnectionOption {
 impl FromStr for ConnectionOption {
     type Err = ();
     fn from_str(s: &str) -> Result<ConnectionOption, ()> {
-        match s {
-            "keep-alive" => Ok(KeepAlive),
-            "close" => Ok(Close),
-            s => Ok(ConnectionHeader(UniCase(s.to_string())))
-        }
+        Ok(match s {
+            "keep-alive" => KeepAlive,
+            "close" => Close,
+            s => ConnectionHeader(UniCase(s.to_string())),
+        })
     }
 }
 
-impl fmt::Display for ConnectionOption {
-    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
-        write!(fmt, "{}", match *self {
+impl Display for ConnectionOption {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        f.write_str(match *self {
             KeepAlive => "keep-alive",
             Close => "close",
-            ConnectionHeader(UniCase(ref s)) => s.as_ref()
+            ConnectionHeader(UniCase(ref s)) => s,
         })
     }
 }
@@ -62,13 +79,12 @@ impl Header for Connection {
 }
 
 impl HeaderFormat for Connection {
-    fn fmt_header(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt_header(&self, f: &mut fmt::Formatter) -> fmt::Result {
         let Connection(ref parts) = *self;
-        fmt_comma_delimited(fmt, &parts[..])
+        fmt_comma_delimited(f, &parts[..])
     }
 }
 
 bench_header!(close, Connection, { vec![b"close".to_vec()] });
 bench_header!(keep_alive, Connection, { vec![b"keep-alive".to_vec()] });
 bench_header!(header, Connection, { vec![b"authorization".to_vec()] });
-

src/header/common/cookie.rs

@@ -1,18 +1,22 @@
 use header::{Header, HeaderFormat};
-use std::fmt;
+use std::fmt::{self, Display};
 use std::str::from_utf8;
 
 use cookie::Cookie as CookiePair;
 use cookie::CookieJar;
 
-/// The `Cookie` header. Defined in [RFC6265](tools.ietf.org/html/rfc6265#section-5.4):
+/// `Cookie` header, defined in [RFC6265](http://tools.ietf.org/html/rfc6265#section-5.4)
 ///
-/// > If the user agent does attach a Cookie header field to an HTTP
-/// > request, the user agent must send the cookie-string
-/// > as the value of the header field.
+/// If the user agent does attach a Cookie header field to an HTTP
+/// request, the user agent must send the cookie-string
+/// as the value of the header field.
 ///
-/// > When the user agent generates an HTTP request, the user agent MUST NOT
-/// > attach more than one Cookie header field.
+/// When the user agent generates an HTTP request, the user agent MUST NOT
+/// attach more than one Cookie header field.
+///
+/// # Example values
+/// * `SID=31d4d96e407aad42`
+/// * `SID=31d4d96e407aad42; lang=en-US`
 #[derive(Clone, PartialEq, Debug)]
 pub struct Cookie(pub Vec<CookiePair>);
 
@@ -48,13 +52,13 @@ impl Header for Cookie {
 }
 
 impl HeaderFormat for Cookie {
-    fn fmt_header(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt_header(&self, f: &mut fmt::Formatter) -> fmt::Result {
         let cookies = &self.0;
         for (i, cookie) in cookies.iter().enumerate() {
             if i != 0 {
-                try!(fmt.write_str("; "));
+                try!(f.write_str("; "));
             }
-            try!(write!(fmt, "{}", cookie.pair()));
+            try!(Display::fmt(&cookie.pair(), f));
         }
         Ok(())
     }

src/header/common/host.rs

@@ -65,10 +65,10 @@ impl Header for Host {
 }
 
 impl HeaderFormat for Host {
-    fn fmt_header(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt_header(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self.port {
-            None | Some(80) | Some(443) => write!(fmt, "{}", self.hostname),
-            Some(port) => write!(fmt, "{}:{}", self.hostname, port)
+            None | Some(80) | Some(443) => f.write_str(&self.hostname[..]),
+            Some(port) => write!(f, "{}:{}", self.hostname, port)
         }
     }
 }
@@ -97,4 +97,3 @@ mod tests {
 }
 
 bench_header!(bench, Host, { vec![b"foo.com:3000".to_vec()] });
-

src/header/common/if_range.rs

@@ -1,4 +1,5 @@
-use header::{self, EntityTag, HttpDate};
+use std::fmt::{self, Display};
+use header::{self, Header, HeaderFormat, EntityTag, HttpDate};
 
 /// `If-Range` header, defined in [RFC7233](http://tools.ietf.org/html/rfc7233#section-3.2)
 ///
@@ -31,7 +32,7 @@ pub enum IfRange {
     Date(HttpDate),
 }
 
-impl header::Header for IfRange {
+impl Header for IfRange {
     fn header_name() -> &'static str {
         "If-Range"
     }
@@ -48,18 +49,17 @@ impl header::Header for IfRange {
     }
 }
 
-impl header::HeaderFormat for IfRange {
+impl HeaderFormat for IfRange {
     fn fmt_header(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
         match self {
-            &IfRange::EntityTag(ref x) => write!(f, "{}", x),
-            &IfRange::Date(ref x) => write!(f, "{}", x),
+            &IfRange::EntityTag(ref x) => Display::fmt(x, f),
+            &IfRange::Date(ref x) => Display::fmt(x, f),
         }
     }
 }
 
-impl ::std::fmt::Display for IfRange {
-    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
-        use header::HeaderFormat;
+impl Display for IfRange {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         self.fmt_header(f)
     }
 }

src/header/common/mod.rs

@@ -258,7 +258,7 @@ macro_rules! header {
         impl $crate::header::HeaderFormat for $id {
             fn fmt_header(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
                 match *self {
-                    $id::Any => write!(f, "*"),
+                    $id::Any => f.write_str("*"),
                     $id::Items(ref fields) => $crate::header::parsing::fmt_comma_delimited(f, &fields[..])
                 }
             }

src/header/common/pragma.rs

@@ -42,10 +42,10 @@ impl Header for Pragma {
 
 impl HeaderFormat for Pragma {
     fn fmt_header(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        match *self {
-            Pragma::NoCache => write!(f, "no-cache"),
-            Pragma::Ext(ref string) => write!(f, "{}", string),
-        }
+        f.write_str(match *self {
+            Pragma::NoCache => "no-cache",
+            Pragma::Ext(ref string) => &string[..],
+        })
     }
 }