itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-09-28 12:10:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix incorrect documentation links & formatting (#2332)

Browse Source 
The streams documentation referred to module-level 'split' doc which is no longer there
This commit is contained in:
Nikita Baksalyar 2020-04-12 14:59:37 +01:00 committed by GitHub
parent 1e679748ec
commit 8118f8f117
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 1 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tokio/src/net/tcp/stream.rs
View File

@ -614,9 +614,6 @@ impl TcpStream {
/// Splits a `TcpStream` into a read half and a write half, which can be used /// Splits a `TcpStream` into a read half and a write half, which can be used
/// to read and write the stream concurrently. /// to read and write the stream concurrently.
///
/// See the module level documenation of [`split`](super::split) for more
/// details.
pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>) { pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>) {
split(self) split(self)
} }

3
tokio/src/net/udp/socket.rs
View File

@ -74,9 +74,6 @@ impl UdpSocket {
/// Splits the `UdpSocket` into a receive half and a send half. The two parts /// Splits the `UdpSocket` into a receive half and a send half. The two parts
/// can be used to receive and send datagrams concurrently, even from two /// can be used to receive and send datagrams concurrently, even from two
/// different tasks. /// different tasks.
///
/// See the module level documenation of [`split`](super::split) for more
/// details.
pub fn split(self) -> (RecvHalf, SendHalf) { pub fn split(self) -> (RecvHalf, SendHalf) {
split(self) split(self)
} }

3
tokio/src/net/unix/stream.rs
View File

@ -111,9 +111,6 @@ impl UnixStream {
/// Split a `UnixStream` into a read half and a write half, which can be used /// Split a `UnixStream` into a read half and a write half, which can be used
/// to read and write the stream concurrently. /// to read and write the stream concurrently.
///
/// See the module level documenation of [`split`](super::split) for more
/// details.
pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>) { pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>) {
split(self) split(self)
} }

2
tokio/src/sync/mpsc/error.rs
View File

@ -96,7 +96,7 @@ impl Error for TryRecvError {}
// ===== ClosedError ===== // ===== ClosedError =====
/// Error returned by [`Sender::poll_ready`](super::Sender::poll_ready)]. /// Error returned by [`Sender::poll_ready`](super::Sender::poll_ready).
#[derive(Debug)] #[derive(Debug)]
pub struct ClosedError(()); pub struct ClosedError(());