review

tokio-rs · Dec 16, 2023 · 3e04637 · 3e04637
1 parent 46af376
commit 3e04637
Show file tree

Hide file tree

Showing 3 changed files with 113 additions and 107 deletions.
diff --git a/tokio/src/io/join.rs b/tokio/src/io/join.rs
@@ -7,116 +7,122 @@ use std::io;
 use std::pin::Pin;
 use std::task::{Context, Poll};
 
-cfg_io_util! {
-    pin_project_lite::pin_project! {
-        /// Joins two values implementing `AsyncRead` and `AsyncWrite` into a
-        /// single handle.
-        pub struct Join<R, W> {
-            #[pin]
-            reader: R,
-            #[pin]
-            writer: W,
-        }
+/// Join two values implementing `AsyncRead` and `AsyncWrite` into a
+/// single handle.
+pub fn join<R, W>(reader: R, writer: W) -> Join<R, W>
+where
+    R: AsyncRead,
+    W: AsyncWrite,
+{
+    Join { reader, writer }
+}
+
+pin_project_lite::pin_project! {
+    /// Joins two values implementing `AsyncRead` and `AsyncWrite` into a
+    /// single handle.
+    pub struct Join<R, W> {
+        #[pin]
+        reader: R,
+        #[pin]
+        writer: W,
+    }
+}
+
+impl<R, W> Join<R, W>
+where
+    R: AsyncRead,
+    W: AsyncWrite,
+{
+    /// Splits this `Join` back into its `AsyncRead` and `AsyncWrite`
+    /// components.
+    pub fn into_inner(self) -> (R, W) {
+        (self.reader, self.writer)
+    }
+
+    /// Returns a reference to the inner reader.
+    pub fn reader(&self) -> &R {
+        &self.reader
+    }
+
+    /// Returns a reference to the inner writer.
+    pub fn writer(&self) -> &W {
+        &self.writer
+    }
+
+    /// Returns a mutable reference to the inner reader.
+    pub fn reader_mut(&mut self) -> &mut R {
+        &mut self.reader
+    }
+
+    /// Returns a mutable reference to the inner writer.
+    pub fn writer_mut(&mut self) -> &mut W {
+        &mut self.writer
     }
 
-    impl<R, W> Join<R, W>
-    where
-        R: AsyncRead + Unpin,
-        W: AsyncWrite + Unpin,
-    {
-        /// Join two values implementing `AsyncRead` and `AsyncWrite` into a
-        /// single handle.
-        pub fn new(reader: R, writer: W) -> Self {
-            Self { reader, writer }
-        }
-
-        /// Splits this `Join` back into its `AsyncRead` and `AsyncWrite`
-        /// components.
-        pub fn split(self) -> (R, W) {
-            (self.reader, self.writer)
-        }
-
-        /// Returns a reference to the inner reader.
-        pub fn reader(&self) -> &R {
-            &self.reader
-        }
-
-        /// Returns a reference to the inner writer.
-        pub fn writer(&self) -> &W {
-            &self.writer
-        }
-
-        /// Returns a mutable reference to the inner reader.
-        pub fn reader_mut(&mut self) -> &mut R {
-            &mut self.reader
-        }
-
-        /// Returns a mutable reference to the inner writer.
-        pub fn writer_mut(&mut self) -> &mut W {
-            &mut self.writer
-        }
+    pub fn reader_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R> {
+        self.project().reader
     }
 
-    impl<R, W> AsyncRead for Join<R, W>
-    where
-        R: AsyncRead + Unpin,
-    {
-        fn poll_read(
-            self: Pin<&mut Self>,
-            cx: &mut Context<'_>,
-            buf: &mut ReadBuf<'_>,
-        ) -> Poll<Result<(), io::Error>> {
-            self.project().reader.poll_read(cx, buf)
-        }
+    pub fn writer_pin_mut(self: Pin<&mut Self>) -> Pin<&mut W> {
+        self.project().writer
     }
+}
+
+impl<R, W> AsyncRead for Join<R, W>
+where
+    R: AsyncRead + Unpin,
+{
+    fn poll_read(
+        self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+        buf: &mut ReadBuf<'_>,
+    ) -> Poll<Result<(), io::Error>> {
+        self.project().reader.poll_read(cx, buf)
+    }
+}
 
-    impl<R, W> AsyncWrite for Join<R, W>
-    where
-        W: AsyncWrite + Unpin,
-    {
-        fn poll_write(
-            self: Pin<&mut Self>,
-            cx: &mut Context<'_>,
-            buf: &[u8],
-        ) -> Poll<Result<usize, io::Error>> {
-            self.project().writer.poll_write(cx, buf)
-        }
-
-        fn poll_flush(
-            self: Pin<&mut Self>,
-            cx: &mut Context<'_>,
-        ) -> Poll<Result<(), io::Error>> {
-            self.project().writer.poll_flush(cx)
-        }
-
-        fn poll_shutdown(
-            self: Pin<&mut Self>,
-            cx: &mut Context<'_>,
-        ) -> Poll<Result<(), io::Error>> {
-            self.project().writer.poll_shutdown(cx)
-        }
-
-        fn poll_write_vectored(
-            self: Pin<&mut Self>,
-            cx: &mut Context<'_>,
-            bufs: &[io::IoSlice<'_>]
-        ) -> Poll<Result<usize, io::Error>> {
-            self.project().writer.poll_write_vectored(cx, bufs)
-        }
-
-        fn is_write_vectored(&self) -> bool {
-            self.writer.is_write_vectored()
-        }
+impl<R, W> AsyncWrite for Join<R, W>
+where
+    W: AsyncWrite + Unpin,
+{
+    fn poll_write(
+        self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+        buf: &[u8],
+    ) -> Poll<Result<usize, io::Error>> {
+        self.project().writer.poll_write(cx, buf)
     }
 
-    impl<R, W> fmt::Debug for Join<R, W>
-        where R: fmt::Debug, W: fmt::Debug
-    {
-        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
-            fmt.debug_struct("Join")
-                .field("writer", &self.writer)
-                .field("reader", &self.reader)
-                .finish()
-        }
+    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+        self.project().writer.poll_flush(cx)
+    }
+
+    fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+        self.project().writer.poll_shutdown(cx)
+    }
+
+    fn poll_write_vectored(
+        self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+        bufs: &[io::IoSlice<'_>],
+    ) -> Poll<Result<usize, io::Error>> {
+        self.project().writer.poll_write_vectored(cx, bufs)
+    }
+
+    fn is_write_vectored(&self) -> bool {
+        self.writer.is_write_vectored()
+    }
+}
+
+impl<R, W> fmt::Debug for Join<R, W>
+where
+    R: fmt::Debug,
+    W: fmt::Debug,
+{
+    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
+        fmt.debug_struct("Join")
+            .field("writer", &self.writer)
+            .field("reader", &self.reader)
+            .finish()
     }
 }
diff --git a/tokio/src/io/mod.rs b/tokio/src/io/mod.rs
@@ -266,7 +266,7 @@ cfg_io_util! {
     mod split;
     pub use split::{split, ReadHalf, WriteHalf};
     mod join;
-    pub use join::Join;
+    pub use join::{join, Join};
 
     pub(crate) mod seek;
     pub(crate) mod util;

diff --git a/tokio/tests/io_join.rs b/tokio/tests/io_join.rs
@@ -1,7 +1,7 @@
 #![warn(rust_2018_idioms)]
-#![cfg(all(feature = "full", not(target_os = "wasi")))] // Wasi does not support panic recovery
+#![cfg(feature = "full")]
 
-use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, Join, ReadBuf};
+use tokio::io::{join, AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, Join, ReadBuf};
 
 use std::io;
 use std::pin::Pin;
@@ -61,7 +61,7 @@ fn is_send_and_sync() {
 
 #[test]
 fn method_delegation() {
-    let mut rw = Join::new(R, W);
+    let mut rw = join(R, W);
     let mut buf = [0; 1];
 
     tokio_test::block_on(async move {