Address platform-specific behavior in TcpStream::shutdown

Fixes rust-lang#25164
steveklabnik · Apr 26, 2017 · 29e6656 · 29e6656
1 parent 15ce540
commit 29e6656
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/libstd/net/tcp.rs b/src/libstd/net/tcp.rs
@@ -177,6 +177,13 @@ impl TcpStream {
     ///
     /// [`Shutdown`]: ../../std/net/enum.Shutdown.html
     ///
+    /// # Platform-specific behavior
+    ///
+    /// Calling this function multiple times may result in different behavior,
+    /// depending on the operating system. On Linux, the second call will
+    /// return `Ok(())`, but on macOS, it will return `ErrorKind::NotConnected`.
+    /// This may change in the future.
+    ///
     /// # Examples
     ///
     /// ```no_run