Updates!

Author: kyleect

README.md

@@ -1,7 +1,13 @@
 # http_message
 
+Parse partial/non spec compliant HTTP messages.
+
+## Partial HTTP Message
+
+A partial HTTP message contains the potential spans for `method`, `uri`, `http_version`, `headers`, and `body`. The HTTP message does not need to be spec compliant so things like `http_version` are optional.
+
 ```rust
-use http_message::PartialHttpRequest;
+use http_message::{PartialHttpRequest, error::Error, models::request::HttpRequest};
 
 fn main() {
     let partial = PartialHttpRequest::from_str("GET https://example.com\nx-key: 123").unwrap();
@@ -18,7 +24,36 @@ fn main() {
     assert_eq!(Some(&(24..34)), partial.header_span("x-key"));
     assert_eq!(Some("x-key: 123"), partial.header_str("x-key"));
 
-    let request: HttpRequest = partial.into();
+    let request: Result<HttpRequest, Error> = partial.try_into();
+
+    assert_eq!(Err(Error::missing_required("http_version")), request);
+}
+```
+
+## Parsed HTTP Message
+
+A parsed HTTP message contains the spans for `method`, `uri`, `http_version`, `headers`, and `body`. The HTTP message does need to be spec compliant so things like `http_version` are required.
+
+```rust
+use http_message::models::{parsed_request::ParsedHttpRequest, request::HttpRequest, uri::Uri};
+
+fn main() {
+    let parsed =
+        ParsedHttpRequest::from_str("GET https://example.com HTTP/1.1\nx-key: 123\n\n").unwrap();
+
+    assert_eq!(&(0..3), parsed.method_span());
+    assert_eq!("GET", parsed.method_str());
+
+    assert_eq!(&(4..23), parsed.uri_span());
+    assert_eq!("https://example.com", parsed.uri_str());
+
+    assert_eq!(&(24..32), parsed.http_version_span());
+    assert_eq!("HTTP/1.1", parsed.http_version_str());
+
+    assert_eq!(Some(&(33..44)), parsed.header_span("x-key"));
+    assert_eq!(Some("x-key: 123\n"), parsed.header_str("x-key"));
+
+    let request: HttpRequest = parsed.into();
 
     assert_eq!(
         HttpRequest {

examples/parsed.rs

@@ -0,0 +1,31 @@
+use http_message::models::{parsed_request::ParsedHttpRequest, request::HttpRequest, uri::Uri};
+
+fn main() {
+    let parsed =
+        ParsedHttpRequest::from_str("GET https://example.com HTTP/1.1\nx-key: 123\n\n").unwrap();
+
+    assert_eq!(&(0..3), parsed.method_span());
+    assert_eq!("GET", parsed.method_str());
+
+    assert_eq!(&(4..23), parsed.uri_span());
+    assert_eq!("https://example.com", parsed.uri_str());
+
+    assert_eq!(&(24..32), parsed.http_version_span());
+    assert_eq!("HTTP/1.1", parsed.http_version_str());
+
+    assert_eq!(Some(&(33..44)), parsed.header_span("x-key"));
+    assert_eq!(Some("x-key: 123\n"), parsed.header_str("x-key"));
+
+    let request: HttpRequest = parsed.into();
+
+    assert_eq!(
+        HttpRequest {
+            uri: Uri::new("https://example.com"),
+            method: "GET".into(),
+            http_version: "HTTP/1.1".into(),
+            headers: vec![("x-key", "123").into()],
+            body: None
+        },
+        request
+    );
+}

examples/main.rs examples/partial.rsexamples/main.rs renamed to examples/partial.rs

@@ -1,7 +1,4 @@
-use http_message::{
-    PartialHttpRequest,
-    models::{request::HttpRequest, uri::Uri},
-};
+use http_message::{PartialHttpRequest, error::Error, models::request::HttpRequest};
 
 fn main() {
     let partial = PartialHttpRequest::from_str("GET https://example.com\nx-key: 123").unwrap();
@@ -18,16 +15,7 @@ fn main() {
     assert_eq!(Some(&(24..34)), partial.header_span("x-key"));
     assert_eq!(Some("x-key: 123"), partial.header_str("x-key"));
 
-    let request: HttpRequest = partial.into();
+    let request: Result<HttpRequest, Error> = partial.try_into();
 
-    assert_eq!(
-        HttpRequest {
-            uri: Uri::new("https://example.com"),
-            method: "GET".into(),
-            http_version: "HTTP/1.1".into(),
-            headers: vec![("x-key", "123").into()],
-            body: None
-        },
-        request
-    );
+    assert_eq!(Err(Error::missing_required("http_version")), request);
 }

src/error.rs

@@ -1,7 +1,17 @@
 use snafu::prelude::*;
 
-#[derive(Debug, Snafu)]
+#[derive(Debug, Snafu, PartialEq)]
 pub enum Error {
-    #[snafu(display("ID may not be less than 10, but it was {id}"))]
-    InvalidId { id: u16 },
+    #[snafu(display("HTTP Message strings can't be empty"))]
+    EmptyHttpMessage,
+    #[snafu(display("Required but not found: {key}"))]
+    MissingRequired { key: String },
+}
+
+impl Error {
+    pub fn missing_required(key: &str) -> Self {
+        Self::MissingRequired {
+            key: key.to_string(),
+        }
+    }
 }

src/models/mod.rs

@@ -1,5 +1,6 @@
 pub mod body;
 pub mod headers;
+pub mod parsed_request;
 pub mod partial_request;
 pub mod request;
 pub mod response;