Rename Fut to ResponseFuture (#29)

* rename Fut to ResponseFuture

* update readme

* fix http-service-mock, fmt

Author: prasannavl

README.md

@@ -94,13 +94,13 @@ impl Server {
 impl HttpService for Server {
     type Connection = ();
     type ConnectionFuture = future::Ready<Result<(), std::io::Error>>;
-    type Fut = FutureObj<'static, Result<http_service::Response, std::io::Error>>;
+    type ResponseFuture = FutureObj<'static, Result<http_service::Response, std::io::Error>>;
 
     fn connect(&self) -> Self::ConnectionFuture {
         future::ok(())
     }
 
-    fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::Fut {
+    fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::ResponseFuture {
         let message = self.message.clone();
         FutureObj::new(Box::new(async move {
             Ok(Response::new(http_service::Body::from(message)))

examples/simple_response.rs

@@ -22,13 +22,13 @@ impl Server {
 impl HttpService for Server {
     type Connection = ();
     type ConnectionFuture = future::Ready<Result<(), std::io::Error>>;
-    type Fut = FutureObj<'static, Result<http_service::Response, std::io::Error>>;
+    type ResponseFuture = FutureObj<'static, Result<http_service::Response, std::io::Error>>;
 
     fn connect(&self) -> Self::ConnectionFuture {
         future::ok(())
     }
 
-    fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::Fut {
+    fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::ResponseFuture {
         let message = self.message.clone();
         FutureObj::new(Box::new(async move {
             Ok(Response::new(http_service::Body::from(message)))

http-service-mock/src/lib.rs

@@ -26,7 +26,10 @@ impl<T: HttpService> TestBackend<T> {
     }
 
     /// Send a request to the simulated server
-    pub fn simulate(&mut self, req: Request) -> Result<Response, <T::Fut as TryFuture>::Error> {
+    pub fn simulate(
+        &mut self,
+        req: Request,
+    ) -> Result<Response, <T::ResponseFuture as TryFuture>::Error> {
         block_on(
             self.service
                 .respond(&mut self.connection, req)

src/lib.rs

@@ -31,13 +31,13 @@
 //! impl HttpService for Server {
 //!     type Connection = ();
 //!     type ConnectionFuture = future::Ready<Result<(), std::io::Error>>;
-//!     type Fut = FutureObj<'static, Result<http_service::Response, std::io::Error>>;
+//!     type ResponseFuture = FutureObj<'static, Result<http_service::Response, std::io::Error>>;
 //!
 //!     fn connect(&self) -> Self::ConnectionFuture {
 //!         future::ok(())
 //!     }
 //!
-//!     fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::Fut {
+//!     fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::ResponseFuture {
 //!         let message = self.message.clone();
 //!         FutureObj::new(Box::new(
 //!             async move {
@@ -96,6 +96,7 @@ impl Body {
     }
 
     /// Reads the stream into a new `Vec`.
+    #[allow(unused_mut)]
     #[allow(clippy::wrong_self_convention)] // https://github.com/rust-lang/rust-clippy/issues/4037
     pub async fn into_vec(mut self) -> std::io::Result<Vec<u8>> {
         let mut bytes = Vec::new();
@@ -164,29 +165,29 @@ pub trait HttpService: Send + Sync + 'static {
     /// Returning an error will result in the server immediately dropping
     /// the connection. It is usually preferable to instead return an HTTP response
     /// with an error status code.
-    type Fut: Send + 'static + TryFuture<Ok = Response>;
+    type ResponseFuture: Send + 'static + TryFuture<Ok = Response>;
 
     /// Begin handling a single request.
     ///
     /// The handler is given shared access to the service itself, and mutable access
     /// to the state for the connection where the request is taking place.
-    fn respond(&self, conn: &mut Self::Connection, req: Request) -> Self::Fut;
+    fn respond(&self, conn: &mut Self::Connection, req: Request) -> Self::ResponseFuture;
 }
 
-impl<F, Fut> HttpService for F
+impl<F, R> HttpService for F
 where
-    F: Send + Sync + 'static + Fn(Request) -> Fut,
-    Fut: Send + 'static + TryFuture<Ok = Response>,
-    Fut::Error: Send,
+    F: Send + Sync + 'static + Fn(Request) -> R,
+    R: Send + 'static + TryFuture<Ok = Response>,
+    R::Error: Send,
 {
     type Connection = ();
-    type ConnectionFuture = future::Ready<Result<(), Fut::Error>>;
+    type ConnectionFuture = future::Ready<Result<(), R::Error>>;
     fn connect(&self) -> Self::ConnectionFuture {
         future::ok(())
     }
 
-    type Fut = Fut;
-    fn respond(&self, _: &mut (), req: Request) -> Self::Fut {
+    type ResponseFuture = R;
+    fn respond(&self, _: &mut (), req: Request) -> Self::ResponseFuture {
         (self)(req)
     }
 }