summaryrefslogtreecommitdiffstats
path: root/tokio/src/net/tcp/split.rs
diff options
context:
space:
mode:
authorAlice Ryhl <alice@ryhl.io>2020-04-24 00:11:49 +0200
committerGitHub <noreply@github.com>2020-04-23 15:11:49 -0700
commit9bcb50660e2d9de26a4373aaf4ab8f324c8ebbe8 (patch)
tree744803b55ae681aeae2f6ba02c3f939744bdce34 /tokio/src/net/tcp/split.rs
parenta3aab864d776692bc53357b115c8b06d789c630b (diff)
docs: make it easier to discover extension traits (#2434)
Refs: #2307
Diffstat (limited to 'tokio/src/net/tcp/split.rs')
-rw-r--r--tokio/src/net/tcp/split.rs31
1 files changed, 27 insertions, 4 deletions
diff --git a/tokio/src/net/tcp/split.rs b/tokio/src/net/tcp/split.rs
index 39dca996..469056ac 100644
--- a/tokio/src/net/tcp/split.rs
+++ b/tokio/src/net/tcp/split.rs
@@ -19,14 +19,32 @@ use std::net::Shutdown;
use std::pin::Pin;
use std::task::{Context, Poll};
-/// Read half of a `TcpStream`.
+/// Read half of a [`TcpStream`], created by [`split`].
+///
+/// Reading from a `ReadHalf` is usually done using the convenience methods found on the
+/// [`AsyncReadExt`] trait. Examples import this trait through [the prelude].
+///
+/// [`TcpStream`]: TcpStream
+/// [`split`]: TcpStream::split()
+/// [`AsyncReadExt`]: trait@crate::io::AsyncReadExt
+/// [the prelude]: crate::prelude
#[derive(Debug)]
pub struct ReadHalf<'a>(&'a TcpStream);
-/// Write half of a `TcpStream`.
+/// Write half of a [`TcpStream`], created by [`split`].
///
-/// Note that in the `AsyncWrite` implemenation of this type, `poll_shutdown` will
+/// Note that in the [`AsyncWrite`] implemenation of this type, [`poll_shutdown`] will
/// shut down the TCP stream in the write direction.
+///
+/// Writing to an `OwnedWriteHalf` is usually done using the convenience methods found
+/// on the [`AsyncWriteExt`] trait. Examples import this trait through [the prelude].
+///
+/// [`TcpStream`]: TcpStream
+/// [`split`]: TcpStream::split()
+/// [`AsyncWrite`]: trait@crate::io::AsyncWrite
+/// [`poll_shutdown`]: fn@crate::io::AsyncWrite::poll_shutdown
+/// [`AsyncWriteExt`]: trait@crate::io::AsyncWriteExt
+/// [the prelude]: crate::prelude
#[derive(Debug)]
pub struct WriteHalf<'a>(&'a TcpStream);
@@ -74,6 +92,8 @@ impl ReadHalf<'_> {
///
/// See the [`TcpStream::peek`] level documenation for more details.
///
+ /// [`TcpStream::peek`]: TcpStream::peek
+ ///
/// # Examples
///
/// ```no_run
@@ -101,7 +121,10 @@ impl ReadHalf<'_> {
/// }
/// ```
///
- /// [`TcpStream::peek`]: TcpStream::peek
+ /// The [`read`] method is defined on the [`AsyncReadExt`] trait.
+ ///
+ /// [`read`]: fn@crate::io::AsyncReadExt::read
+ /// [`AsyncReadExt`]: trait@crate::io::AsyncReadExt
pub async fn peek(&mut self, buf: &mut [u8]) -> io::Result<usize> {
poll_fn(|cx| self.poll_peek(cx, buf)).await
}