Merge branch 'release/v0.1.1'

rousan · rousan · commit 4ca8d429bdb4 · 2020-04-07T00:16:40.000+05:30
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
 name = "stream-body"
-version = "0.1.0"
+version = "0.1.1"
 description = "An HttpBody implementation with efficient streaming support for the Rust HTTP library hyper"
 homepage = "https://github.com/rousan/stream-body"
 repository = "https://github.com/rousan/stream-body"
-keywords = ["rust", "hyper", "asynchronous", "stream", "writer", "channel"]
+keywords = ["rust", "hyper", "asynchronous", "stream", "writer"]
 categories = ["asynchronous"]
 authors = ["Rousan Ali <rousanali786@gmail.com>"]
 readme = "README.md"
diff --git a/examples/create-channel.rs b/examples/create-channel.rs
diff --git a/examples/from-reader.rs b/examples/from-reader.rs
@@ -0,0 +1,29 @@
+use hyper::service::{make_service_fn, service_fn};
+use hyper::{Body, Request, Response, Server};
+use std::{convert::Infallible, net::SocketAddr};
+use stream_body::StreamBody;
+use tokio::fs::File;
+
+async fn handle(_: Request<Body>) -> Result<Response<StreamBody>, Infallible> {
+    let f = File::open("large-file.pdf").await.unwrap();
+    let file_size = f.metadata().await.unwrap().len();
+
+    Ok(Response::builder()
+        .header("Content-Type", "application/pdf")
+        .header("Content-Length", file_size.to_string())
+        .body(StreamBody::from_reader(f))
+        .unwrap())
+}
+
+#[tokio::main]
+async fn main() {
+    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
+
+    let make_svc = make_service_fn(|_conn| async { Ok::<_, Infallible>(service_fn(handle)) });
+
+    let server = Server::bind(&addr).serve(make_svc);
+
+    if let Err(e) = server.await {
+        eprintln!("server error: {}", e);
+    }
+}
diff --git a/src/body.rs b/src/body.rs
@@ -6,6 +6,7 @@ use http::{HeaderMap, HeaderValue};
 use http_body::{Body, SizeHint};
 use pin_project_lite::pin_project;
 use std::borrow::Cow;
+use std::marker::Unpin;
 use std::mem::MaybeUninit;
 use std::pin::Pin;
 use std::sync::{Arc, Mutex};
@@ -94,6 +95,24 @@ impl StreamBody {
 
         (w, body)
     }
+
+    /// A helper method to convert an [AsyncRead](https://docs.rs/tokio/0.2.16/tokio/io/trait.AsyncRead.html) to a `StreamBody`. If there is any error
+    /// thrown during the reading/writing, it will be logged via [log::error!](https://docs.rs/log/0.4.10/log/macro.error.html).
+    pub fn from_reader<R: AsyncRead + Unpin + Send + 'static>(mut r: R) -> StreamBody {
+        let (mut w, body) = StreamBody::channel();
+
+        tokio::spawn(async move {
+            if let Err(err) = io::copy(&mut r, &mut w).await {
+                log::error!(
+                    "{}: StreamBody: Something went wrong while piping the provided reader to the body: {}",
+                    env!("CARGO_PKG_NAME"),
+                    err
+                )
+            }
+        });
+
+        body
+    }
 }
 
 impl Body for StreamBody {
