feat: added TryFrom<BytesMut> for MessageHead struct

Author: darkseid-is

header-plz/src/body_headers/parse.rs

@@ -58,7 +58,7 @@ mod tests {
                        User-Agent: curl/7.29.0\r\n\
                        Connection: keep-alive\r\n\r\n";
         let buf = BytesMut::from(request);
-        let result = MessageHead::<Request>::new(buf).unwrap();
+        let result = MessageHead::<Request>::try_from(buf).unwrap();
         let body_headers = result.parse_body_headers();
         assert!(body_headers.is_none());
     }
@@ -72,7 +72,7 @@ mod tests {
                        User-Agent: curl/7.29.0\r\n\
                        Connection: keep-alive\r\n\r\n";
         let buf = BytesMut::from(request);
-        let result = MessageHead::<Request>::new(buf).unwrap();
+        let result = MessageHead::<Request>::try_from(buf).unwrap();
         let body_headers = result.parse_body_headers();
         assert!(body_headers.is_none());
     }
@@ -84,7 +84,7 @@ mod tests {
                        Content-Type: application/json\r\n\
                        \r\n";
         let buf = BytesMut::from(request);
-        let result = MessageHead::<Request>::new(buf).unwrap();
+        let result = MessageHead::<Request>::try_from(buf).unwrap();
         match result.parse_body_headers() {
             Some(body_headers) => {
                 assert!(body_headers.content_type.is_some());
@@ -106,7 +106,7 @@ mod tests {
                        Content-Encoding: gzip\r\n\
                        Transfer-Encoding: chunked\r\n\r\n";
         let buf = BytesMut::from(request);
-        let result = MessageHead::<Request>::new(buf).unwrap();
+        let result = MessageHead::<Request>::try_from(buf).unwrap();
         match result.parse_body_headers() {
             Some(body_headers) => {
                 assert_eq!(body_headers.content_type.unwrap(), ContentType::Application);
@@ -130,7 +130,7 @@ mod tests {
                         Content-Type: text/plain\r\n\
                         Content-Length: 12\r\n\r\n";
         let buf = BytesMut::from(response);
-        let result = MessageHead::<Response>::new(buf).unwrap();
+        let result = MessageHead::<Response>::try_from(buf).unwrap();
         let body_headers = result.parse_body_headers();
         if let Some(body_headers) = body_headers {
             assert!(body_headers.content_encoding.is_none());
@@ -151,7 +151,7 @@ mod tests {
                         Host: localhost\r\n\
                         Content-Type: text/plain\r\n\r\n";
         let buf = BytesMut::from(response);
-        let result = MessageHead::<Response>::new(buf).unwrap();
+        let result = MessageHead::<Response>::try_from(buf).unwrap();
         let body_headers = result.parse_body_headers();
         if let Some(body_headers) = body_headers {
             assert!(body_headers.content_encoding.is_none());
@@ -170,7 +170,7 @@ mod tests {
                         Content-Length: 0\r\n\
                         Content-Type: text/plain\r\n\r\n";
         let buf = BytesMut::from(response);
-        let result = MessageHead::<Response>::new(buf).unwrap();
+        let result = MessageHead::<Response>::try_from(buf).unwrap();
         let body_headers = result.parse_body_headers();
         assert!(body_headers.is_none());
     }

header-plz/src/info_line/mod.rs

@@ -6,7 +6,7 @@ use error::*;
 
 // Trait for parsing info line of request and response.
 pub trait InfoLine {
-    fn build_infoline(raw: BytesMut) -> Result<Self, InfoLineError>
+    fn try_build_infoline(raw: BytesMut) -> Result<Self, InfoLineError>
     where
         Self: Sized;
 

header-plz/src/info_line/request.rs

@@ -28,7 +28,7 @@ pub struct Request {
  */
 
 impl InfoLine for Request {
-    fn build_infoline(mut data: BytesMut) -> Result<Request, InfoLineError> {
+    fn try_build_infoline(mut data: BytesMut) -> Result<Request, InfoLineError> {
         let mut index =
             data.iter()
                 .position(|&x| x == OWS as u8)
@@ -96,7 +96,7 @@ mod tests {
         let buf = BytesMut::from(req);
         let verify = buf[0..20].to_owned();
         let verify_ptr = buf[0..20].as_ptr_range();
-        let request = Request::build_infoline(buf).unwrap();
+        let request = Request::try_build_infoline(buf).unwrap();
         assert_eq!(request.method(), b"GET");
         assert_eq!(request.uri_as_string(), "/echo");
         assert_eq!(request.version, " HTTP/1.1\r\n");
@@ -111,7 +111,7 @@ mod tests {
         let buf = BytesMut::from(req);
         let verify_ptr = buf[..37].as_ptr_range();
         let verify = buf.clone();
-        match Request::build_infoline(buf) {
+        match Request::try_build_infoline(buf) {
             Ok(info_line) => {
                 assert_eq!(info_line.method, "CONNECT ");
                 assert_eq!(info_line.uri, "www.google.com:443");
@@ -132,7 +132,7 @@ mod tests {
         let buf = BytesMut::from(req);
         let verify_ptr = buf[..].as_ptr_range();
         let verify = buf.clone();
-        match Request::build_infoline(buf) {
+        match Request::try_build_infoline(buf) {
             Ok(info_line) => {
                 assert_eq!(info_line.method, "GET ");
                 assert_eq!(info_line.uri, "http://www.google.com/");
@@ -153,7 +153,7 @@ mod tests {
         let buf = BytesMut::from(req);
         let verify_ptr = buf[..].as_ptr_range();
         let verify = buf.clone();
-        match Request::build_infoline(buf) {
+        match Request::try_build_infoline(buf) {
             Ok(info_line) => {
                 assert_eq!(info_line.method, "GET ");
                 assert_eq!(info_line.uri, "http://www.google.com:8080/");
@@ -172,7 +172,7 @@ mod tests {
     fn test_return_queries() -> Result<(), Box<dyn Error>> {
         let req = "GET /users?param=value&param2=value2 HTTP/1.1\r\n\r\n";
         let buf = BytesMut::from(req);
-        let info_line = Request::build_infoline(buf)?;
+        let info_line = Request::try_build_infoline(buf)?;
         let uri = info_line.uri()?;
         let query = uri.query().unwrap();
         assert_eq!("param=value&param2=value2", query);

header-plz/src/info_line/response.rs

@@ -18,7 +18,7 @@ pub struct Response {
  */
 
 impl InfoLine for Response {
-    fn build_infoline(mut data: BytesMut) -> Result<Response, InfoLineError> {
+    fn try_build_infoline(mut data: BytesMut) -> Result<Response, InfoLineError> {
         // "1" in decimal
         let index = if data[5] == 49 {
             9
@@ -73,7 +73,7 @@ mod tests {
         let buf = BytesMut::from(response);
         let verify = buf.clone();
         let initial_ptr = buf.as_ptr_range();
-        let response = Response::build_infoline(buf).unwrap();
+        let response = Response::try_build_infoline(buf).unwrap();
         assert_eq!(response.version, "HTTP/1.1 ");
         assert_eq!(response.status, "200");
         assert_eq!(response.reason, " OK\r\n");
@@ -88,7 +88,7 @@ mod tests {
         let buf = BytesMut::from(response);
         let verify = buf.clone();
         let initial_ptr = buf.as_ptr_range();
-        let response = Response::build_infoline(buf).unwrap();
+        let response = Response::try_build_infoline(buf).unwrap();
         assert_eq!(response.version, "HTTP/2 ");
         assert_eq!(response.status, "200");
         assert_eq!(response.reason, " OK\r\n");

header-plz/src/message_head/mod.rs

@@ -0,0 +1,45 @@
+use crate::{header_map::HeaderMap, info_line::InfoLine};
+use bytes::BytesMut;
+mod try_from_bytes;
+
+// Represent the Header region Infoline + HeaderMap.
+#[cfg_attr(any(test, debug_assertions), derive(Debug, PartialEq, Eq))]
+pub struct MessageHead<T> {
+    info_line: T,
+    header_map: HeaderMap,
+}
+
+impl<T> MessageHead<T>
+where
+    T: InfoLine,
+{
+    pub fn new(info_line: T, header_map: HeaderMap) -> Self {
+        MessageHead {
+            info_line,
+            header_map,
+        }
+    }
+
+    // Convert into Data
+    pub fn into_data(self) -> BytesMut {
+        let mut data = self.info_line.into_data();
+        data.unsplit(self.header_map.into_data());
+        data
+    }
+
+    pub fn header_map(&self) -> &HeaderMap {
+        &self.header_map
+    }
+
+    pub fn infoline(&self) -> &T {
+        &self.info_line
+    }
+
+    pub fn infoline_as_mut(&mut self) -> &mut T {
+        &mut self.info_line
+    }
+
+    pub fn header_map_as_mut(&mut self) -> &mut HeaderMap {
+        &mut self.header_map
+    }
+}

header-plz/src/message_head.rs …r-plz/src/message_head/try_from_bytes.rsheader-plz/src/message_head.rs renamed to header-plz/src/message_head/try_from_bytes.rs header-plz/src/message_head.rs renamed to header-plz/src/message_head/try_from_bytes.rs

@@ -1,31 +1,29 @@
-use crate::{error::HeaderReadError, header_map::HeaderMap, info_line::InfoLine};
 use bytes::BytesMut;
 
-#[cfg_attr(any(test, debug_assertions), derive(Debug, PartialEq, Eq))]
-pub struct MessageHead<T> {
-    info_line: T,
-    header_map: HeaderMap,
-}
+use crate::{error::HeaderReadError, header_map::HeaderMap, info_line::InfoLine};
+
+use super::MessageHead;
 
-// Represent the Header region Infoline + HeaderMap.
-impl<T> MessageHead<T>
+/* Steps:
+ *      1. Find CR in buf.
+ *      2. Split buf at CR_index + 2 (CRLF)
+ *      3. Build Infoline
+ *
+ * Error:
+ *      HttpReadError::InfoLine       [3]
+ *      HttpReadError::HeaderStruct   [Default]
+ */
+
+impl<T> TryFrom<BytesMut> for MessageHead<T>
 where
     T: InfoLine,
 {
-    /* Steps:
-     *      1. Find CR in buf.
-     *      2. Split buf at CR_index + 2 (CRLF)
-     *      3. Build Infoline
-     *
-     * Error:
-     *      HttpReadError::InfoLine       [3]
-     *      HttpReadError::HeaderStruct   [Default]
-     */
+    type Error = HeaderReadError;
 
-    pub fn new(mut data: BytesMut) -> Result<Self, HeaderReadError> {
+    fn try_from(mut data: BytesMut) -> Result<Self, HeaderReadError> {
         if let Some(infoline_index) = data.iter().position(|&x| x == 13) {
             let raw = data.split_to(infoline_index + 2);
-            let info_line = T::build_infoline(raw)?;
+            let info_line = T::try_build_infoline(raw)?;
             return Ok(Self {
                 info_line,
                 header_map: HeaderMap::from(data),
@@ -35,29 +33,6 @@ where
             String::from_utf8_lossy(&data).to_string(),
         ))
     }
-
-    // Convert into Data
-    pub fn into_data(self) -> BytesMut {
-        let mut data = self.info_line.into_data();
-        data.unsplit(self.header_map.into_data());
-        data
-    }
-
-    pub fn header_map(&self) -> &HeaderMap {
-        &self.header_map
-    }
-
-    pub fn infoline(&self) -> &T {
-        &self.info_line
-    }
-
-    pub fn infoline_as_mut(&mut self) -> &mut T {
-        &mut self.info_line
-    }
-
-    pub fn header_map_as_mut(&mut self) -> &mut HeaderMap {
-        &mut self.header_map
-    }
 }
 
 #[cfg(test)]
@@ -68,7 +43,7 @@ mod tests {
     use super::*;
 
     #[test]
-    fn test_header_struct_build_request() {
+    fn test_message_head_request_try_from() {
         let request = "GET / HTTP/1.1\r\n\
                        Host: localhost\r\n\
                        Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\n\
@@ -79,7 +54,7 @@ mod tests {
                        ";
         let buf = BytesMut::from(request);
         let org = buf.as_ptr_range();
-        let result = MessageHead::<Request>::new(buf).unwrap();
+        let result = MessageHead::<Request>::try_from(buf).unwrap();
         assert_eq!(result.info_line.method(), b"GET");
         assert_eq!(result.info_line.uri_as_string(), "/");
         let verify = result.into_data();
@@ -88,14 +63,14 @@ mod tests {
     }
 
     #[test]
-    fn test_header_struct_build_infoline_response() {
+    fn test_message_head_response_try_from() {
         let response = "HTTP/1.1 200 OK\r\n\
                         Host: localhost\r\n\
                         Content-Type: text/plain\r\n\
                         Content-Length: 12\r\n\r\n";
         let buf = BytesMut::from(response);
         let org = buf.as_ptr_range();
-        let result = MessageHead::<Response>::new(buf).unwrap();
+        let result = MessageHead::<Response>::try_from(buf).unwrap();
         assert_eq!(result.info_line.status(), b"200");
         let verify = result.into_data();
         assert_eq!(verify, response);