diff options
| author | Zahari Dichev <zaharidichev@gmail.com> | 2020-10-24 15:26:01 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-24 14:26:01 +0200 |
| commit | ce173fdc918c5934561560a97d366fce6edb36d0 (patch) | |
| tree | b02982334d44d76b405441b4c95c1fe6e7deb830 /tokio/src/net/tcp/stream.rs | |
| parent | e804f88d60071f0d89db85aaa4a073857904b545 (diff) | |
docs: update docs for `from_std` functions (#3016)
Fixes: #3007
Diffstat (limited to 'tokio/src/net/tcp/stream.rs')
| -rw-r--r-- | tokio/src/net/tcp/stream.rs | 6 |
1 files changed, 4 insertions, 2 deletions
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 /// |