Merge pull request #19 from jayjamesjay/v0.5.0

V0.5.0

Author: jayjamesjay

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "http_req"
-version = "0.4.11"
+version = "0.5.0"
 license = "MIT"
 description = "simple and lightweight HTTP client with built-in HTTPS support"
 repository = "https://github.com/jayjamesjay/http_req"
@@ -11,7 +11,7 @@ keywords = ["http", "client", "request"]
 edition = "2018"
 
 [dependencies]
-unicase = "^2.3"
+unicase = "^2.4"
 
 [features]
 default = ["native-tls"]

Cargo.toml

@@ -1,7 +1,7 @@
 # http_req
 [![Build Status](https://travis-ci.org/jayjamesjay/http_req.svg?branch=master)](https://travis-ci.org/jayjamesjay/http_req)
-[![Crates.io](https://img.shields.io/badge/crates.io-v0.4.11-orange.svg?longCache=true)](https://crates.io/crates/http_req)
-[![Docs.rs](https://docs.rs/http_req/badge.svg)](https://docs.rs/http_req/0.4.11/http_req/)
+[![Crates.io](https://img.shields.io/badge/crates.io-v0.5.0-orange.svg?longCache=true)](https://crates.io/crates/http_req)
+[![Docs.rs](https://docs.rs/http_req/badge.svg)](https://docs.rs/http_req/0.5.0/http_req/)
 
 Simple and lightweight HTTP client with built-in HTTPS support.
 Currently it's in heavy development and may frequently change.
@@ -28,7 +28,7 @@ fn main() {
 In order to use `http_req` with `rustls` in your project,  add following lines to `Cargo.toml`:
 ```toml
 [dependencies]
-http_req  = {version="^0.4", default-features = false, features = ["rust-tls"]}
+http_req  = {version="^0.5", default-features = false, features = ["rust-tls"]}
 ```
 
 ## License

README.md

@@ -2060,4 +2060,4 @@ repeated concatenation.</p>
 </div><h4 id='method.clone_into' class="method"><span id='clone_into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../std/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&amp;self, target: <a class="primitive" href="../primitive.reference.html">&amp;mut </a>T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/borrow.rs.html#98-100' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API.  (<code>toowned_clone_into </code><a href="https://github.com/rust-lang/rust/issues/41263">#41263</a>)</summary><p>recently added</p>
 </details></div></div><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="../../std/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
 </div></div><h3 id='impl-ToString-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <a class="trait" href="../../std/string/trait.ToString.html" title="trait std::string::ToString">ToString</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../std/fmt/trait.Display.html" title="trait std::fmt::Display">Display</a> + ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-ToString-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/string.rs.html#2145-2155' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.to_string-1' class="method"><span id='to_string.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../std/string/trait.ToString.html#tymethod.to_string' class='fnname'>to_string</a>(&amp;self) -&gt; <a class="struct" href="../../std/string/struct.String.html" title="struct std::string::String">String</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/string.rs.html#2147-2154' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="../../std/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
-</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
+</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>

benches/res.txt

@@ -5,6 +5,6 @@ fn main() {
     let res = request::get("https://doc.rust-lang.org/", &mut writer).unwrap();
 
     println!("Status: {} {}", res.status_code(), res.reason());
-    println!("{:?}", res.headers());
+    println!("Headers {}", res.headers());
     //println!("{}", String::from_utf8_lossy(&writer));
 }

examples/get.rs

@@ -5,8 +5,11 @@ use std::{error::Error as StdErr, fmt, io, num, str};
 pub enum ParseErr {
     Utf8(str::Utf8Error),
     Int(num::ParseIntError),
-    Empty,
+    StatusErr,
+    HeadersErr,
+    UriErr,
     Invalid,
+    Empty,
 }
 
 impl fmt::Display for ParseErr {
@@ -22,8 +25,11 @@ impl StdErr for ParseErr {
         match self {
             Utf8(_) => "invalid character",
             Int(_) => "cannot parse number",
-            Empty => "nothing to parse",
             Invalid => "invalid value",
+            Empty => "nothing to parse",
+            StatusErr => "status line contains invalid values",
+            HeadersErr => "headers contain invalid values",
+            UriErr => "uri contains invalid characters",
         }
     }
 }

src/error.rs

@@ -45,7 +45,7 @@ where
 }
 
 ///HTTP request methods
-#[derive(Debug, PartialEq, Clone)]
+#[derive(Debug, PartialEq, Clone, Copy)]
 pub enum Method {
     GET,
     HEAD,
@@ -112,7 +112,7 @@ impl<'a> RequestBuilder<'a> {
     ///Creates new `RequestBuilder` with default parameters
     pub fn new(uri: &'a Uri) -> RequestBuilder<'a> {
         RequestBuilder {
-            headers: Headers::default_http(&uri),
+            headers: Headers::default_http(uri),
             uri,
             method: Method::GET,
             version: HTTP_V,
@@ -284,7 +284,6 @@ impl<'a> Request<'a> {
         U: ToString + ?Sized,
     {
         self.inner.header(key, val);
-
         self
     }
 
@@ -294,18 +293,9 @@ impl<'a> Request<'a> {
         Method: From<T>,
     {
         self.inner.method(method);
-
         self
     }
 
-    #[deprecated(note = "Please use method instead")]
-    pub fn set_method<T>(&mut self, method: T)
-    where
-        Method: From<T>,
-    {
-        self.inner.method(method);
-    }
-
     ///Sets body for request
     pub fn body(&mut self, body: &'a [u8]) -> &mut Self {
         self.inner.body(body);
@@ -330,11 +320,6 @@ impl<'a> Request<'a> {
         self
     }
 
-    #[deprecated(note = "Please use the read_timeout instead")]
-    pub fn set_connect_timeout(&mut self, timeout: Option<Duration>) -> &mut Self {
-        self.connect_timeout(timeout)
-    }
-
     ///Sets read timeout on internal `TcpStream` instance
     ///
     ///`timeout` will be passed to
@@ -349,11 +334,6 @@ impl<'a> Request<'a> {
         self
     }
 
-    #[deprecated(note = "Please use the read_timeout instead")]
-    pub fn set_read_timeout(&mut self, timeout: Option<Duration>) -> &mut Self {
-        self.read_timeout(timeout)
-    }
-
     ///Sets write timeout on internal `TcpStream` instance
     ///
     ///`timeout` will be passed to
@@ -368,11 +348,6 @@ impl<'a> Request<'a> {
         self
     }
 
-    #[deprecated(note = "Please use the write_timeout instead")]
-    pub fn set_write_timeout(&mut self, timeout: Option<Duration>) -> &mut Self {
-        self.write_timeout(timeout)
-    }
-
     ///Add a file containing the PEM-encoded certificates that should be added in the trusted root store.
     pub fn root_cert_file_pem(&mut self, file_path: &'a Path) -> &mut Self {
         self.root_cert_file_pem = Some(file_path);
@@ -442,9 +417,8 @@ where
 ///Creates and sends GET request. Returns response for this request.
 pub fn get<T: AsRef<str>, U: Write>(uri: T, writer: &mut U) -> Result<Response, error::Error> {
     let uri = uri.as_ref().parse::<Uri>()?;
-    let request = Request::new(&uri);
 
-    request.send(writer)
+    Request::new(&uri).send(writer)
 }
 
 ///Creates and sends HEAD request. Returns response for this request.

src/request.rs

@@ -27,19 +27,12 @@ impl Response {
     pub fn from_head(head: &[u8]) -> Result<Response, Error> {
         let mut head = str::from_utf8(head)?.splitn(2, '\n');
 
-        let status = head.next().ok_or(ParseErr::Invalid)?.parse()?;
-        let headers = head.next().ok_or(ParseErr::Invalid)?.parse()?;
+        let status = head.next().ok_or(ParseErr::StatusErr)?.parse()?;
+        let headers = head.next().ok_or(ParseErr::HeadersErr)?.parse()?;
 
         Ok(Response { status, headers })
     }
 
-    #[deprecated(note = "Please use the from_head instead")]
-    pub fn parse_head(head: &[u8]) -> Result<(Status, Headers), ParseErr> {
-        let head = Self::from_head(head).map_err(|_| ParseErr::Invalid)?;
-
-        Ok((head.status, head.headers))
-    }
-
     ///Parses `Response` from slice of bytes. Writes it's body to `writer`.
     pub fn try_from<T: Write>(res: &[u8], writer: &mut T) -> Result<Response, Error> {
         if res.is_empty() {
@@ -116,8 +109,8 @@ impl str::FromStr for Status {
     fn from_str(status_line: &str) -> Result<Status, Self::Err> {
         let mut status_line = status_line.trim().splitn(3, ' ');
 
-        let version = status_line.next().ok_or(ParseErr::Invalid)?;
-        let code: StatusCode = status_line.next().ok_or(ParseErr::Invalid)?.parse()?;
+        let version = status_line.next().ok_or(ParseErr::StatusErr)?;
+        let code: StatusCode = status_line.next().ok_or(ParseErr::StatusErr)?.parse()?;
         let reason = status_line
             .next()
             .unwrap_or_else(|| code.reason().unwrap_or("Unknown"));
@@ -126,7 +119,7 @@ impl str::FromStr for Status {
     }
 }
 
-///Wrapper around HashMap<String, String> with additional functionality for parsing HTTP headers
+///Wrapper around HashMap<Ascii<String>, String> with additional functionality for parsing HTTP headers
 ///
 ///# Example
 ///```
@@ -164,7 +157,7 @@ impl Headers {
     }
 
     ///Returns a reference to the value corresponding to the key.
-    pub fn get<T: ToString>(&self, k: T) -> Option<&std::string::String> {
+    pub fn get<T: ToString + ?Sized>(&self, k: &T) -> Option<&std::string::String> {
         self.0.get(&Ascii::new(k.to_string()))
     }
 
@@ -187,7 +180,7 @@ impl Headers {
         let mut headers = Headers::with_capacity(4);
 
         headers.insert("Host", &uri.host_header().unwrap_or_default());
-        headers.insert("Referer", uri);
+        headers.insert("Referer", &uri);
 
         headers
     }
@@ -203,15 +196,15 @@ impl str::FromStr for Headers {
             let headers = headers
                 .lines()
                 .map(|elem| {
-                    let idx = elem.find(":").unwrap();
+                    let idx = elem.find(':').unwrap();
                     let (key, value) = elem.split_at(idx);
                     (Ascii::new(key.to_string()), value[1..].trim().to_string())
                 })
                 .collect();
 
             Ok(Headers(headers))
         } else {
-            Err(ParseErr::Invalid)
+            Err(ParseErr::HeadersErr)
         }
     }
 }
@@ -228,6 +221,17 @@ impl From<Headers> for HashMap<Ascii<String>, String> {
     }
 }
 
+impl fmt::Display for Headers {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        let headers: String = self
+            .iter()
+            .map(|(key, val)| format!("  {}: {}\r\n", key, val))
+            .collect();
+
+        write!(f, "{{\r\n{}}}", headers)
+    }
+}
+
 ///Code sent by a server in response to a client's request.
 ///
 ///# Example