Clarify interfaction between File::set_len and file cursor

This commit is contained in:
jethrogb 2018-02-23 11:57:38 -08:00 committed by GitHub
parent 063deba92e
commit cfad25ee8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.