diff options
author | Jeb Rosen <jeb@jebrosen.com> | 2020-06-18 12:36:06 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-18 21:36:06 +0200 |
commit | 0ab28627e2e7dabfe1f8450101b720d623c6c5e7 (patch) | |
tree | d1fb262c68b9220e6d1b2f57bf514e38a8bc3b54 | |
parent | a43ec11daf7306e34cff1c60fd01437bd34d8aba (diff) |
docs: remove unneeded doc from AsyncReadExt::read_ext() (#2621)
This paragraph from `std::io::Read::read_ext()` applies to
*implementors* of `Read`. Since `AsyncReadExt` can't and shouldn't be
implemented outside of this crate, this documentation is unnecessary.
-rw-r--r-- | tokio/src/io/util/async_read_ext.rs | 6 |
1 files changed, 0 insertions, 6 deletions
diff --git a/tokio/src/io/util/async_read_ext.rs b/tokio/src/io/util/async_read_ext.rs index fcd2cce4..50f600c8 100644 --- a/tokio/src/io/util/async_read_ext.rs +++ b/tokio/src/io/util/async_read_ext.rs @@ -238,12 +238,6 @@ cfg_io_util! { /// This function reads as many bytes as necessary to completely fill /// the specified buffer `buf`. /// - /// No guarantees are provided about the contents of `buf` when this - /// function is called, implementations cannot rely on any property of - /// the contents of `buf` being `true`. It is recommended that - /// implementations only write data to `buf` instead of reading its - /// contents. - /// /// # Errors /// /// If the operation encounters an "end of file" before completely |