From 6a8f6f5a90a15dd840c009075009ecffb98e52f8 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Wed, 26 Apr 2023 12:12:53 +0200 Subject: [PATCH] net: add uds doc alias for unix sockets (#5659) --- tokio/src/net/unix/datagram/socket.rs | 1 + tokio/src/net/unix/listener.rs | 1 + tokio/src/net/unix/stream.rs | 1 + 3 files changed, 3 insertions(+) diff --git a/tokio/src/net/unix/datagram/socket.rs b/tokio/src/net/unix/datagram/socket.rs index bd16dd6e0..c97d101aa 100644 --- a/tokio/src/net/unix/datagram/socket.rs +++ b/tokio/src/net/unix/datagram/socket.rs @@ -91,6 +91,7 @@ cfg_net_unix! { /// # Ok(()) /// # } /// ``` + #[cfg_attr(docsrs, doc(alias = "uds"))] pub struct UnixDatagram { io: PollEvented, } diff --git a/tokio/src/net/unix/listener.rs b/tokio/src/net/unix/listener.rs index 6a050f39b..37a5a4ae4 100644 --- a/tokio/src/net/unix/listener.rs +++ b/tokio/src/net/unix/listener.rs @@ -45,6 +45,7 @@ cfg_net_unix! { /// } /// } /// ``` + #[cfg_attr(docsrs, doc(alias = "uds"))] pub struct UnixListener { io: PollEvented, } diff --git a/tokio/src/net/unix/stream.rs b/tokio/src/net/unix/stream.rs index f8afa5a82..201645ba1 100644 --- a/tokio/src/net/unix/stream.rs +++ b/tokio/src/net/unix/stream.rs @@ -34,6 +34,7 @@ cfg_net_unix! { /// /// [`shutdown()`]: fn@crate::io::AsyncWriteExt::shutdown /// [`UnixListener::accept`]: crate::net::UnixListener::accept + #[cfg_attr(docsrs, doc(alias = "uds"))] pub struct UnixStream { io: PollEvented, }