improve examples

Author: jayjamesjay

examples/get.rs

@@ -1,10 +1,14 @@
 use http_req::request;
 
 fn main() {
-    let mut writer = Vec::new(); //container for body of a response
-    let res = request::get("https://www.rust-lang.org/learn", &mut writer).unwrap();
+    //Container for body of a response.
+    let mut body = Vec::new();
 
+    //Sends a HTTP GET request and processes the response. Saves body of the response to `body` variable.
+    let res = request::get("https://www.rust-lang.org/learn", &mut body).unwrap();
+
+    //Prints details about the response.
     println!("Status: {} {}", res.status_code(), res.reason());
-    println!("Headers {}", res.headers());
-    //println!("{}", String::from_utf8_lossy(&writer));
+    println!("Headers: {}", res.headers());
+    //println!("{}", String::from_utf8_lossy(&body));
 }

examples/head.rs

@@ -1,8 +1,10 @@
 use http_req::request;
 
 fn main() {
+    //Sends a HTTP HEAD request and processes the response.
     let res = request::head("https://www.rust-lang.org/learn").unwrap();
 
+    //Prints details about the response.
     println!("Status: {} {}", res.status_code(), res.reason());
-    println!("{:?}", res.headers());
+    println!("Headers: {}", res.headers());
 }

examples/post.rs

@@ -1,11 +1,17 @@
 use http_req::request;
 
 fn main() {
-    let mut writer = Vec::new(); //container for body of a response
-    const BODY: &[u8; 27] = b"field1=value1&field2=value2";
-    let res = request::post("https://httpbin.org/post", BODY, &mut writer).unwrap();
+    //Container for body of a response.
+    let mut res_body = Vec::new();
 
+    //Body of a request.
+    const REQ_BODY: &[u8; 27] = b"field1=value1&field2=value2";
+
+    //Sends a HTTP POST request and processes the response.
+    let res = request::post("https://httpbin.org/post", REQ_BODY, &mut res_body).unwrap();
+
+    //Prints details about the response.
     println!("Status: {} {}", res.status_code(), res.reason());
-    println!("Headers {}", res.headers());
-    //println!("{}", String::from_utf8_lossy(&writer));
+    println!("Headers: {}", res.headers());
+    println!("{}", String::from_utf8_lossy(&res_body));
 }

examples/request_builder_get.rs

@@ -2,26 +2,27 @@ use http_req::{request::RequestBuilder, tls, uri::Uri};
 use std::{convert::TryFrom, net::TcpStream};
 
 fn main() {
-    //Parse uri and assign it to variable `addr`
-    let addr: Uri = Uri::try_from("https://doc.rust-lang.org/").unwrap();
+    //Parses a URI and assigns it to a variable `addr`.
+    let addr: Uri = Uri::try_from("https://www.rust-lang.org/learn").unwrap();
 
-    //Connect to remote host
+    //Connects to a remote host. Uses information from `addr`.
     let stream = TcpStream::connect((addr.host().unwrap(), addr.corr_port())).unwrap();
 
-    //Open secure connection over TlsStream, because of `addr` (https)
+    //Opens a secure connection over TlsStream. This is required due to use of `https` protocol.
     let mut stream = tls::Config::default()
         .connect(addr.host().unwrap_or(""), stream)
         .unwrap();
 
-    //Container for response's body
+    //Container for a response's body.
     let mut writer = Vec::new();
 
-    //Add header `Connection: Close`
+    //Adds a header `Connection: Close`.
     let response = RequestBuilder::new(&addr)
         .header("Connection", "Close")
         .send(&mut stream, &mut writer)
         .unwrap();
 
     println!("Status: {} {}", response.status_code(), response.reason());
+    println!("Headers: {}", response.headers());
     //println!("{}", String::from_utf8_lossy(&writer));
 }