about summary refs log tree commit diff
path: root/library/std
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-08-16 08:58:02 -0700
committerJosh Triplett <josh@joshtriplett.org>2023-08-16 09:00:16 -0700
commit5210f482d7309004c0ff3f6306f052f8d5adb67b (patch)
tree230cd7dde991ce1dcb6bac4e1a0f05195f35710a /library/std
parent1ec628d7fa3cbf1241e93fb7aff1faa0441eea09 (diff)
downloadrust-5210f482d7309004c0ff3f6306f052f8d5adb67b.tar.gz
rust-5210f482d7309004c0ff3f6306f052f8d5adb67b.zip
Partially revert #107200
`Ok(0)` is indeed something the caller may interpret as an error, but
that's the *correct* thing to return if the writer can't accept any more
bytes.
Diffstat (limited to 'library/std')
-rw-r--r--library/std/src/io/mod.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/library/std/src/io/mod.rs b/library/std/src/io/mod.rs
index 5c1d2d8f46c..71d91f21362 100644
--- a/library/std/src/io/mod.rs
+++ b/library/std/src/io/mod.rs
@@ -1425,9 +1425,9 @@ pub trait Write {
     ///
     /// If this method consumed `n > 0` bytes of `buf` it must return [`Ok(n)`].
     /// If the return value is `Ok(n)` then `n` must satisfy `n <= buf.len()`.
-    /// Unless `buf` is empty, this function shouldn’t return `Ok(0)` since the
-    /// caller may interpret that as an error.  To indicate lack of space,
-    /// implementors should return [`ErrorKind::StorageFull`] error instead.
+    /// A return value of `Ok(0)` typically means that the underlying object is
+    /// no longer able to accept bytes and will likely not be able to in the
+    /// future as well, or that the buffer provided is empty.
     ///
     /// # Errors
     ///