rename write_ready to flush

ntex-io/CHANGES.md

@@ -1,5 +1,11 @@
 # Changes
 
+## [0.1.0-b.3] - 2021-12-xx
+
+* Rename .poll_write_ready() to .poll_flush()
+
+* Rename .write_ready() to .flush()
+
 ## [0.1.0-b.2] - 2021-12-20
 
 * Removed `WriteRef` and `ReadRef`

ntex-io/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ntex-io"
-version = "0.1.0-b.2"
+version = "0.1.0-b.3"
 authors = ["ntex contributors <team@ntex.rs>"]
 description = "Utilities for encoding and decoding frames"
 keywords = ["network", "framework", "async", "futures"]

ntex-io/src/io.rs

@@ -408,18 +408,25 @@ impl<F> Io<F> {
             self.0 .0.write_task.wake();
         }
 
-        poll_fn(|cx| self.poll_write_ready(cx, true))
+        poll_fn(|cx| self.poll_flush(cx, true))
             .await
             .map_err(Either::Right)?;
         Ok(())
     }
 
     #[inline]
-    /// Wake write task and instruct to write data.
+    /// Wake write task and instruct to flush data.
     ///
-    /// This is async version of .poll_write_ready() method.
+    /// This is async version of .poll_flush() method.
+    pub async fn flush(&self, full: bool) -> Result<(), io::Error> {
+        poll_fn(|cx| self.poll_flush(cx, full)).await
+    }
+
+    #[doc(hidden)]
+    #[deprecated]
+    #[inline]
     pub async fn write_ready(&self, full: bool) -> Result<(), io::Error> {
-        poll_fn(|cx| self.poll_write_ready(cx, full)).await
+        poll_fn(|cx| self.poll_flush(cx, full)).await
     }
 
     #[inline]
@@ -431,16 +438,12 @@ impl<F> Io<F> {
 
 impl<F> Io<F> {
     #[inline]
-    /// Wake write task and instruct to write data.
+    /// Wake write task and instruct to flush data.
     ///
-    /// If full is true then wake up dispatcher when all data is flushed
+    /// If `full` is true then wake up dispatcher when all data is flushed
     /// otherwise wake up when size of write buffer is lower than
     /// buffer max size.
-    pub fn poll_write_ready(
-        &self,
-        cx: &mut Context<'_>,
-        full: bool,
-    ) -> Poll<io::Result<()>> {
+    pub fn poll_flush(&self, cx: &mut Context<'_>, full: bool) -> Poll<io::Result<()>> {
         // check io error
         if !self.0 .0.is_io_open() {
             return Poll::Ready(Err(self.0 .0.error.take().unwrap_or_else(|| {
@@ -470,6 +473,17 @@ impl<F> Io<F> {
         Poll::Ready(Ok(()))
     }
 
+    #[doc(hidden)]
+    #[deprecated]
+    #[inline]
+    pub fn poll_write_ready(
+        &self,
+        cx: &mut Context<'_>,
+        full: bool,
+    ) -> Poll<io::Result<()>> {
+        self.poll_flush(cx, full)
+    }
+
     #[inline]
     /// Wake read task and instruct to read more data
     ///

ntex-io/src/tokio_impl.rs

@@ -383,7 +383,7 @@ impl<F: Filter> AsyncWrite for Io<F> {
     }
 
     fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
-        self.poll_write_ready(cx, false)
+        Io::poll_flush(&*self, cx, false)
     }
 
     fn poll_shutdown(
@@ -428,7 +428,7 @@ impl AsyncWrite for IoBoxed {
     }
 
     fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
-        self.poll_write_ready(cx, false)
+        Self::poll_flush(&*self, cx, false)
     }
 
     fn poll_shutdown(
@@ -648,8 +648,8 @@ mod unixstream {
                                     }
                                     Poll::Ready(Err(e)) => {
                                         log::trace!(
-                                        "write task is closed with err during shutdown"
-                                    );
+                                            "write task is closed with err during shutdown"
+                                        );
                                         this.state.close(Some(e));
                                         return Poll::Ready(());
                                     }