add docs to cookie headers recomending use of cookie crate

dekellum · Oct 28, 2021 · 0b05e9a · 0b05e9a
1 parent 1dfcbfd
commit 0b05e9a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/header/common/cookie.rs b/src/header/common/cookie.rs
@@ -18,6 +18,9 @@ use header::internals::VecMap;
 /// * `SID=31d4d96e407aad42`
 /// * `SID=31d4d96e407aad42; lang=en-US`
 ///
+/// Consider using the _cookie_ crate for parsing/decoding or encoding
+/// cookie values.
+///
 /// # Example
 /// ```
 /// # extern crate http;

diff --git a/src/header/common/set_cookie.rs b/src/header/common/set_cookie.rs
@@ -14,6 +14,11 @@ use std::str::from_utf8;
 /// `SetCookie` _must not_ be encoded as a comma-delimited list. For this
 /// reason, it doesn't implement `fmt::Display` (and `std::string::ToString`).
 ///
+/// Consider using the _cookie_ crate for parsing/decoding or encoding
+/// cookie values. [Usage example].
+///
+/// [Usage example]: https://github.com/dekellum/hyperx/issues/30#issuecomment-733151305
+///
 /// # ABNF
 ///
 /// ```text