Rollup merge of #131462 - cuviper:open_buffered-error, r=RalfJung

Mention allocation errors for `open_buffered` This documents that `File::open_buffered` may return an error on allocation failure.
rust-lang · Oct 9, 2024 · 7a76489 · 7a76489
2 parents 866869b + 7b52e6b
commit 7a76489
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs
@@ -394,7 +394,8 @@ impl File {
     ///
     /// # Errors
     ///
-    /// This function will return an error if `path` does not already exist.
+    /// This function will return an error if `path` does not already exist,
+    /// or if memory allocation fails for the new buffer.
     /// Other errors may also be returned according to [`OpenOptions::open`].
     ///
     /// # Examples