Merge branch 'tokio-rs:master' into master

Author: martin-augment

tokio-util/src/io/reader_stream.rs

@@ -58,6 +58,11 @@ impl<R: AsyncRead> ReaderStream<R> {
     /// Convert an [`AsyncRead`] into a [`Stream`] with item type
     /// `Result<Bytes, std::io::Error>`.
     ///
+    /// Currently, the default capacity 4096 bytes (4 KiB).
+    /// This capacity is not part of the semver contract
+    /// and may be tweaked in future releases without
+    /// requiring a major version bump.
+    ///
     /// [`AsyncRead`]: tokio::io::AsyncRead
     /// [`Stream`]: futures_core::Stream
     pub fn new(reader: R) -> Self {

tokio/src/net/tcp/stream.rs

@@ -1070,6 +1070,13 @@ impl TcpStream {
     /// Successive calls return the same data. This is accomplished by passing
     /// `MSG_PEEK` as a flag to the underlying `recv` system call.
     ///
+    /// # Cancel safety
+    ///
+    /// This method is cancel safe. If the method is used as the event in a
+    /// [`tokio::select!`](crate::select) statement and some other branch
+    /// completes first, then it is guaranteed that no peek was performed, and
+    /// that `buf` has not been modified.
+    ///
     /// # Examples
     ///
     /// ```no_run