From: Till Arnold <throwable42@gmail.com>
Date: Sun, 12 Jan 2020 11:01:37 +0000 (+0100)
Subject: Document behavior of set_nonblocking on UnixListener
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=c32090c130273787b8f9fc8290357a6a9d3222b7;p=rust.git

Document behavior of set_nonblocking on UnixListener
---

diff --git a/src/libstd/sys/unix/ext/net.rs b/src/libstd/sys/unix/ext/net.rs
index e0e6e02a443..4c3cb67c9ee 100644
--- a/src/libstd/sys/unix/ext/net.rs
+++ b/src/libstd/sys/unix/ext/net.rs
@@ -902,6 +902,12 @@ pub fn local_addr(&self) -> io::Result<SocketAddr> {
 
     /// Moves the socket into or out of nonblocking mode.
     ///
+    /// This will result in the `accept` operation becoming nonblocking,
+    /// i.e., immediately returning from their calls. If the IO operation is
+    /// successful, `Ok` is returned and no further action is required. If the
+    /// IO operation could not be completed and needs to be retried, an error
+    /// with kind [`io::ErrorKind::WouldBlock`] is returned.
+    ///
     /// # Examples
     ///
     /// ```no_run
@@ -913,6 +919,8 @@ pub fn local_addr(&self) -> io::Result<SocketAddr> {
     ///     Ok(())
     /// }
     /// ```
+    ///
+    /// [`io::ErrorKind::WouldBlock`]: ../../../io/enum.ErrorKind.html#variant.WouldBlock
     #[stable(feature = "unix_socket", since = "1.10.0")]
     pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
         self.0.set_nonblocking(nonblocking)