From ce173fdc918c5934561560a97d366fce6edb36d0 Mon Sep 17 00:00:00 2001 From: Zahari Dichev Date: Sat, 24 Oct 2020 15:26:01 +0300 Subject: docs: update docs for `from_std` functions (#3016) Fixes: #3007 --- tokio/src/net/tcp/stream.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'tokio/src/net/tcp/stream.rs') diff --git a/tokio/src/net/tcp/stream.rs b/tokio/src/net/tcp/stream.rs index f90e9a39..204a1940 100644 --- a/tokio/src/net/tcp/stream.rs +++ b/tokio/src/net/tcp/stream.rs @@ -145,8 +145,10 @@ impl TcpStream { /// Creates new `TcpStream` from a `std::net::TcpStream`. /// - /// This function will convert a TCP stream created by the standard library - /// to a TCP stream ready to be used with the provided event loop handle. + /// This function is intended to be used to wrap a TCP stream from the + /// standard library in the Tokio equivalent. The conversion assumes nothing + /// about the underlying stream; it is left up to the user to set it in + /// non-blocking mode. /// /// # Examples /// -- cgit v1.2.3