cleaning up comments of ContentCoding and removing changes to ContentEncoding

Author: ParkMyCar

src/common/content_coding.rs

@@ -1,11 +1,13 @@
 use HeaderValue;
 
+// Derives an enum to represent content codings and some helpful impls
 macro_rules! define_content_coding {
     ($($coding:ident; $str:expr,)+) => {   
         #[derive(Copy, Clone, Debug, Eq, PartialEq)]
-        /// Values that are used with headers like `Content-Encoding`
-        /// [RFC7231](https://www.iana.org/assignments/http-parameters/http-parameters.xhtml)
+        /// Values that are used with headers like [`Content-Encoding`](self::ContentEncoding) or 
+        /// [`Accept-Encoding`](self::AcceptEncoding)
         /// 
+        /// [RFC7231](https://www.iana.org/assignments/http-parameters/http-parameters.xhtml)
         pub enum ContentCoding {
             $(
                 #[doc = $str]
@@ -14,18 +16,27 @@ macro_rules! define_content_coding {
         }
 
         impl ContentCoding {
-            /// Returns a static str for a ContentCoding
+            /// Returns a `&'static str` for a `ContentCoding`
+            /// 
+            /// # Example
+            /// 
+            /// ```
+            /// use headers::ContentCoding;
+            /// 
+            /// let coding = ContentCoding::BROTLI;
+            /// assert_eq!(coding.to_static(), "br");
+            /// ```
             #[inline]
             pub fn to_static(&self) -> &'static str {
                 match *self {
                     $(ContentCoding::$coding => $str,)+
                 }
             }
 
-            /// Given a &str returns a ContentCoding. 
+            /// Given a `&str` returns a `ContentCoding` 
             /// 
             /// Note this will never fail, in the case of `&str` being an invalid content coding, 
-            /// will return `ContentCoding::IDENTITY` because identity is generally always an 
+            /// will return `ContentCoding::IDENTITY` because `'identity'` is generally always an 
             /// accepted coding.
             /// 
             /// # Example
@@ -39,14 +50,12 @@ macro_rules! define_content_coding {
             /// let valid = ContentCoding::from_str("gzip");
             /// assert_eq!(valid, ContentCoding::GZIP);
             /// ```
-            /// 
             #[inline]
             pub fn from_str(s: &str) -> Self {
                 ContentCoding::try_from_str(s).unwrap_or_else(|_| ContentCoding::IDENTITY)
             }
 
-            #[inline]
-            /// Given a &str will try to return a ContentCoding
+            /// Given a `&str` will try to return a `ContentCoding`
             /// 
             /// Different from `ContentCoding::from_str(&str)`, if `&str` is an invalid content
             /// coding, it will return `Err(())`
@@ -62,7 +71,7 @@ macro_rules! define_content_coding {
             /// let valid = ContentCoding::try_from_str("gzip");
             /// assert_eq!(valid.unwrap(), ContentCoding::GZIP);
             /// ```
-            /// 
+            #[inline]
             pub fn try_from_str(s: &str) -> Result<Self, ()> {
                 match s {
                     $(

src/common/content_encoding.rs

@@ -39,30 +39,11 @@ derive_header! {
     name: CONTENT_ENCODING
 }
 
-macro_rules! derive_constructor {
-    ($(doc = $doc:expr; $coding:ident,)+) => {
-        $(
-            #[doc = $doc]
-            #[inline]
-            pub fn $coding() -> ContentEncoding {
-                ContentEncoding(HeaderValue::from_static(stringify!($coding)).into())
-            }
-        )+
-    };
-}
-
 impl ContentEncoding {
-    derive_constructor! {
-        doc = "A constructor to easily create a `Content-Encoding`: gzip header";
-        gzip,
-        doc = "A constructor to easily create a `Content-Encoding`: compress header";
-        compress,
-        doc = "A constructor to easily create a `Content-Encoding`: deflate header";
-        deflate,
-        doc = "A constructor to easily create a `Content-Encoding`: identity header";
-        identity,
-        doc = "A constructor to easily create a `Content-Encoding`: br header";
-        br,
+    /// A constructor to easily create a `Content-Encoding: gzip` header.
+    #[inline]
+    pub fn gzip() -> ContentEncoding {
+        ContentEncoding(HeaderValue::from_static("gzip").into())
     }
 
     /// Check if this header contains a given "coding".