Add a comment to Read::read_buf

qinheping · Sep 23, 2024 · 57557c9 · 57557c9
1 parent 4a11249
commit 57557c9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/std/src/io/mod.rs b/std/src/io/mod.rs
@@ -978,6 +978,8 @@ pub trait Read {
     /// with uninitialized buffers. The new data will be appended to any existing contents of `buf`.
     ///
     /// The default implementation delegates to `read`.
+    ///
+    /// This method makes it possible to return both data and an error but it is advised against.
     #[unstable(feature = "read_buf", issue = "78485")]
     fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()> {
         default_read_buf(|b| self.read(b), buf)