Skip to content

Commit 6a8f6f5

Browse files
authored
net: add uds doc alias for unix sockets (#5659)
1 parent 398dfda commit 6a8f6f5

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

tokio/src/net/unix/datagram/socket.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ cfg_net_unix! {
9191
/// # Ok(())
9292
/// # }
9393
/// ```
94+
#[cfg_attr(docsrs, doc(alias = "uds"))]
9495
pub struct UnixDatagram {
9596
io: PollEvented<mio::net::UnixDatagram>,
9697
}

tokio/src/net/unix/listener.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ cfg_net_unix! {
4545
/// }
4646
/// }
4747
/// ```
48+
#[cfg_attr(docsrs, doc(alias = "uds"))]
4849
pub struct UnixListener {
4950
io: PollEvented<mio::net::UnixListener>,
5051
}

tokio/src/net/unix/stream.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ cfg_net_unix! {
3434
///
3535
/// [`shutdown()`]: fn@crate::io::AsyncWriteExt::shutdown
3636
/// [`UnixListener::accept`]: crate::net::UnixListener::accept
37+
#[cfg_attr(docsrs, doc(alias = "uds"))]
3738
pub struct UnixStream {
3839
io: PollEvented<mio::net::UnixStream>,
3940
}

0 commit comments

Comments
 (0)