diff options
| author | bors <bors@rust-lang.org> | 2023-09-01 05:25:44 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2023-09-01 05:25:44 +0000 |
| commit | dc348dbd90cf9f4c0bd1485b4c68aed60b32c433 (patch) | |
| tree | 2a878542b3f23593d7ba06b3e80077575bf8bbb4 /library/std/src | |
| parent | 88d9b37a15b492b0abf59401e99b0809e2696921 (diff) | |
| parent | 0e270b1a972151bd7daf73b04c942369b06d1a63 (diff) | |
| download | rust-dc348dbd90cf9f4c0bd1485b4c68aed60b32c433.tar.gz rust-dc348dbd90cf9f4c0bd1485b4c68aed60b32c433.zip | |
Auto merge of #114448 - SteveLauC:std_fs_read_doc, r=Mark-Simulacrum
docs: improve std::fs::read doc #### What does this PR do 1. Rephrase a confusing sentence in the document of `std::fs::read()` ----- Closes #114432 cc `@Dexus0` `@saethlin`
Diffstat (limited to 'library/std/src')
| -rw-r--r-- | library/std/src/fs.rs | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs index 3c67bea7a22..adc1b85fd85 100644 --- a/library/std/src/fs.rs +++ b/library/std/src/fs.rs @@ -233,8 +233,8 @@ pub struct DirBuilder { /// This function will return an error if `path` does not already exist. /// Other errors may also be returned according to [`OpenOptions::open`]. /// -/// It will also return an error if it encounters while reading an error -/// of a kind other than [`io::ErrorKind::Interrupted`]. +/// While reading from the file, this function handles [`io::ErrorKind::Interrupted`] +/// with automatic retries. See [io::Read] documentation for details. /// /// # Examples /// @@ -271,9 +271,11 @@ pub fn read<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> { /// This function will return an error if `path` does not already exist. /// Other errors may also be returned according to [`OpenOptions::open`]. /// -/// It will also return an error if it encounters while reading an error -/// of a kind other than [`io::ErrorKind::Interrupted`], -/// or if the contents of the file are not valid UTF-8. +/// If the contents of the file are not valid UTF-8, then an error will also be +/// returned. +/// +/// While reading from the file, this function handles [`io::ErrorKind::Interrupted`] +/// with automatic retries. See [io::Read] documentation for details. /// /// # Examples /// |
