summaryrefslogtreecommitdiffstats
path: root/tokio/src/net/unix/incoming.rs
diff options
context:
space:
mode:
Diffstat (limited to 'tokio/src/net/unix/incoming.rs')
-rw-r--r--tokio/src/net/unix/incoming.rs7
1 files changed, 6 insertions, 1 deletions
diff --git a/tokio/src/net/unix/incoming.rs b/tokio/src/net/unix/incoming.rs
index bede96dd..af493604 100644
--- a/tokio/src/net/unix/incoming.rs
+++ b/tokio/src/net/unix/incoming.rs
@@ -16,7 +16,12 @@ impl Incoming<'_> {
Incoming { inner: listener }
}
- #[doc(hidden)] // TODO: dox
+ /// Attempts to poll `UnixStream` by polling inner `UnixListener` to accept
+ /// connection.
+ ///
+ /// If `UnixListener` isn't ready yet, `Poll::Pending` is returned and
+ /// current task will be notified by a waker. Otherwise `Poll::Ready` with
+ /// `Result` containing `UnixStream` will be returned.
pub fn poll_accept(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,