summaryrefslogtreecommitdiffstats
path: root/tokio/src/net/tcp/split.rs
diff options
context:
space:
mode:
authorAlice Ryhl <alice@ryhl.io>2020-07-24 21:56:38 +0200
committerGitHub <noreply@github.com>2020-07-24 12:56:38 -0700
commit4fca1974e9d9f95fab7d723619294cb4b2dcebbb (patch)
treeb44bd16a594adff645d8342656c3cdfcff0c54f3 /tokio/src/net/tcp/split.rs
parent08872c55d161cac08f4feb3e141883a47ab766cf (diff)
net: ensure that unix sockets have both split and into_split (#2687)
The documentation build failed with errors such as error: `[read]` public documentation for `take` links to a private item --> tokio/src/io/util/async_read_ext.rs:1078:9 | 1078 | / /// Creates an adaptor which reads at most `limit` bytes from it. 1079 | | /// 1080 | | /// This function returns a new instance of `AsyncRead` which will read 1081 | | /// at most `limit` bytes, after which it will always return EOF ... | 1103 | | /// } 1104 | | /// ``` | |_______________^ | note: the lint level is defined here --> tokio/src/lib.rs:13:9 | 13 | #![deny(intra_doc_link_resolution_failure)] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ = note: the link appears in this line: bytes read and future calls to [`read()`][read] may succeed.
Diffstat (limited to 'tokio/src/net/tcp/split.rs')
-rw-r--r--tokio/src/net/tcp/split.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/tokio/src/net/tcp/split.rs b/tokio/src/net/tcp/split.rs
index 469056ac..0c1e359f 100644
--- a/tokio/src/net/tcp/split.rs
+++ b/tokio/src/net/tcp/split.rs
@@ -19,7 +19,7 @@ use std::net::Shutdown;
use std::pin::Pin;
use std::task::{Context, Poll};
-/// Read half of a [`TcpStream`], created by [`split`].
+/// Borrowed 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].
@@ -31,12 +31,12 @@ use std::task::{Context, Poll};
#[derive(Debug)]
pub struct ReadHalf<'a>(&'a TcpStream);
-/// Write half of a [`TcpStream`], created by [`split`].
+/// Borrowed write half of a [`TcpStream`], created by [`split`].
///
/// 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
+/// Writing to an `WriteHalf` is usually done using the convenience methods found
/// on the [`AsyncWriteExt`] trait. Examples import this trait through [the prelude].
///
/// [`TcpStream`]: TcpStream