about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorChris Gregory <czipperz@gmail.com>2019-04-01 22:34:57 -0400
committerChris Gregory <czipperz@gmail.com>2019-04-01 22:34:57 -0400
commitb6ebe1bd9e4f6692c390326bca0ef06c24255719 (patch)
treeb42add1849c5ec8fabc504158377cc21a9559643 /src/libstd
parentf48a5dcf8f2427d15b8e8df51b610dbc3448816e (diff)
downloadrust-b6ebe1bd9e4f6692c390326bca0ef06c24255719.tar.gz
rust-b6ebe1bd9e4f6692c390326bca0ef06c24255719.zip
Document using `sync_all`
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/fs.rs7
1 files changed, 3 insertions, 4 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index 06d8ee99b64..99dd0d8eeeb 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -21,10 +21,9 @@ use crate::time::SystemTime;
 /// it was opened with. Files also implement [`Seek`] to alter the logical cursor
 /// that the file contains internally.
 ///
-/// Files are automatically closed when they go out of scope.  All errors are
-/// ignored due to complications with correctly handling them.  For instance, an
-/// error in closing a file could mean that closing failed, or that the file had
-/// an error before closing that was only unearthed by closing the file.
+/// Files are automatically closed when they go out of scope.  Errors detected
+/// on closing are ignored by the implementation of `Drop`.  Use the method
+/// `sync_all` if these errors must be manually handled.
 ///
 /// # Examples
 ///