mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-22 14:55:26 +00:00
fix docs
This commit is contained in:
parent
8abe67c949
commit
2920ed0999
@ -2618,7 +2618,7 @@ pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
|
|||||||
/// # Platform-specific behavior
|
/// # Platform-specific behavior
|
||||||
///
|
///
|
||||||
/// This function currently corresponds to the `opendir` function on Unix
|
/// This function currently corresponds to the `opendir` function on Unix
|
||||||
/// and the `FindFirstFile` function on Windows. Advancing the iterator
|
/// and the `FindFirstFileEx` function on Windows. Advancing the iterator
|
||||||
/// currently corresponds to `readdir` on Unix and `FindNextFile` on Windows.
|
/// currently corresponds to `readdir` on Unix and `FindNextFile` on Windows.
|
||||||
/// Note that, this [may change in the future][changes].
|
/// Note that, this [may change in the future][changes].
|
||||||
///
|
///
|
||||||
|
@ -114,7 +114,7 @@ impl Iterator for ReadDir {
|
|||||||
fn next(&mut self) -> Option<io::Result<DirEntry>> {
|
fn next(&mut self) -> Option<io::Result<DirEntry>> {
|
||||||
if self.handle.0 == c::INVALID_HANDLE_VALUE {
|
if self.handle.0 == c::INVALID_HANDLE_VALUE {
|
||||||
// This iterator was initialized with an `INVALID_HANDLE_VALUE` as its handle.
|
// This iterator was initialized with an `INVALID_HANDLE_VALUE` as its handle.
|
||||||
// Simply return `None` because this is only the case when `FindFirstFileW` in
|
// Simply return `None` because this is only the case when `FindFirstFileExW` in
|
||||||
// the construction of this iterator returns `ERROR_FILE_NOT_FOUND` which means
|
// the construction of this iterator returns `ERROR_FILE_NOT_FOUND` which means
|
||||||
// no matchhing files can be found.
|
// no matchhing files can be found.
|
||||||
return None;
|
return None;
|
||||||
@ -1071,7 +1071,7 @@ pub fn readdir(p: &Path) -> io::Result<ReadDir> {
|
|||||||
first: Some(wfd),
|
first: Some(wfd),
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
// The status `ERROR_FILE_NOT_FOUND` is returned by the `FindFirstFileW` function
|
// The status `ERROR_FILE_NOT_FOUND` is returned by the `FindFirstFileExW` function
|
||||||
// if no matching files can be found, but not necessarily that the path to find the
|
// if no matching files can be found, but not necessarily that the path to find the
|
||||||
// files in does not exist.
|
// files in does not exist.
|
||||||
//
|
//
|
||||||
@ -1093,7 +1093,7 @@ pub fn readdir(p: &Path) -> io::Result<ReadDir> {
|
|||||||
|
|
||||||
// Just return the error constructed from the raw OS error if the above is not the case.
|
// Just return the error constructed from the raw OS error if the above is not the case.
|
||||||
//
|
//
|
||||||
// Note: `ERROR_PATH_NOT_FOUND` would have been returned by the `FindFirstFileW` function
|
// Note: `ERROR_PATH_NOT_FOUND` would have been returned by the `FindFirstFileExW` function
|
||||||
// when the path to search in does not exist in the first place.
|
// when the path to search in does not exist in the first place.
|
||||||
Err(Error::from_raw_os_error(last_error.code as i32))
|
Err(Error::from_raw_os_error(last_error.code as i32))
|
||||||
}
|
}
|
||||||
@ -1234,7 +1234,7 @@ fn metadata(path: &Path, reparse: ReparsePoint) -> io::Result<FileAttr> {
|
|||||||
opts.custom_flags(c::FILE_FLAG_BACKUP_SEMANTICS | reparse.as_flag());
|
opts.custom_flags(c::FILE_FLAG_BACKUP_SEMANTICS | reparse.as_flag());
|
||||||
|
|
||||||
// Attempt to open the file normally.
|
// Attempt to open the file normally.
|
||||||
// If that fails with `ERROR_SHARING_VIOLATION` then retry using `FindFirstFileW`.
|
// If that fails with `ERROR_SHARING_VIOLATION` then retry using `FindFirstFileExW`.
|
||||||
// If the fallback fails for any reason we return the original error.
|
// If the fallback fails for any reason we return the original error.
|
||||||
match File::open(path, &opts) {
|
match File::open(path, &opts) {
|
||||||
Ok(file) => file.file_attr(),
|
Ok(file) => file.file_attr(),
|
||||||
@ -1251,7 +1251,7 @@ fn metadata(path: &Path, reparse: ReparsePoint) -> io::Result<FileAttr> {
|
|||||||
unsafe {
|
unsafe {
|
||||||
let path = maybe_verbatim(path)?;
|
let path = maybe_verbatim(path)?;
|
||||||
|
|
||||||
// `FindFirstFileW` accepts wildcard file names.
|
// `FindFirstFileExW` accepts wildcard file names.
|
||||||
// Fortunately wildcards are not valid file names and
|
// Fortunately wildcards are not valid file names and
|
||||||
// `ERROR_SHARING_VIOLATION` means the file exists (but is locked)
|
// `ERROR_SHARING_VIOLATION` means the file exists (but is locked)
|
||||||
// therefore it's safe to assume the file name given does not
|
// therefore it's safe to assume the file name given does not
|
||||||
@ -1274,7 +1274,7 @@ fn metadata(path: &Path, reparse: ReparsePoint) -> io::Result<FileAttr> {
|
|||||||
// We no longer need the find handle.
|
// We no longer need the find handle.
|
||||||
c::FindClose(handle);
|
c::FindClose(handle);
|
||||||
|
|
||||||
// `FindFirstFileW` reads the cached file information from the
|
// `FindFirstFileExW` reads the cached file information from the
|
||||||
// directory. The downside is that this metadata may be outdated.
|
// directory. The downside is that this metadata may be outdated.
|
||||||
let attrs = FileAttr::from(wfd);
|
let attrs = FileAttr::from(wfd);
|
||||||
if reparse == ReparsePoint::Follow && attrs.file_type().is_symlink() {
|
if reparse == ReparsePoint::Follow && attrs.file_type().is_symlink() {
|
||||||
|
Loading…
Reference in New Issue
Block a user