Update std::fs::remove_dir_all documentation · rust-lang/rust@32080ad (original) (raw)

`@@ -2042,13 +2042,17 @@ pub fn remove_dir<P: AsRef>(path: P) -> io::Result<()> {

2042

`///

2043

`/// # Platform-specific behavior

2044

`///

2045

`` -

/// This function currently corresponds to opendir, lstat, rm and rmdir functions on Unix

2046

`` -

/// and the FindFirstFile, GetFileAttributesEx, DeleteFile, and RemoveDirectory functions

2047

/// on Windows.

2048

/// Note that, this [may change in the future][changes].

2045

`` +

/// This function currently corresponds to openat, fdopendir, unlinkat and lstat functions

2046

`` +

/// on Unix (except for macOS before version 10.10 and REDOX) and the CreateFileW,

2047

`` +

/// GetFileInformationByHandleEx, SetFileInformationByHandle, and NtOpenFile functions on

2048

/// Windows. Note that, this [may change in the future][changes].

2049

`///

2050

`/// [changes]: io#platform-specific-behavior

2051

`///

2052

/// On macOS before version 10.10 and REDOX this function is not protected against time-of-check to

2053

/// time-of-use (TOCTOU) race conditions, and should not be used in security-sensitive code on

2054

/// those platforms. All other platforms are protected.

2055

///

2052

2056

`/// # Errors

2053

2057

`///

2054

2058

`` /// See [fs::remove_file] and [fs::remove_dir].