Clarify interfaction between File::set_len and file cursor

rust-lang · Feb 23, 2018 · cfad25e · cfad25e
1 parent 063deba
commit cfad25e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
@@ -453,6 +453,10 @@ impl File {
     /// will be extended to `size` and have all of the intermediate data filled
     /// in with 0s.
     ///
+    /// The file's cursor isn't changed. In particular, if the cursor was at the
+    /// end and the file is shrunk using this operation, the cursor will now be
+    /// past the end.
+    ///
     /// # Errors
     ///
     /// This function will return an error if the file is not opened for writing.