Skip to content

Commit

Permalink
Rollup merge of rust-lang#129718 - lolbinarycat:remove_dir-docs, r=No…
Browse files Browse the repository at this point in the history
…ratrieb

add guarantee about remove_dir and remove_file error kinds

approved in ACP rust-lang/libs-team#433
  • Loading branch information
matthiaskrgr authored Sep 21, 2024
2 parents c0838c8 + c722641 commit f2290c2
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions library/std/src/fs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1991,6 +1991,11 @@ impl AsInner<fs_imp::DirEntry> for DirEntry {
/// * The file doesn't exist.
/// * The user lacks permissions to remove the file.
///
/// This function will only ever return an error of kind `NotFound` if the given
/// path does not exist. Note that the inverse is not true,
/// ie. if a path does not exist, its removal may fail for a number of reasons,
/// such as insufficient permissions.
///
/// # Examples
///
/// ```no_run
Expand Down Expand Up @@ -2448,6 +2453,11 @@ pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
/// * The user lacks permissions to remove the directory at the provided `path`.
/// * The directory isn't empty.
///
/// This function will only ever return an error of kind `NotFound` if the given
/// path does not exist. Note that the inverse is not true,
/// ie. if a path does not exist, its removal may fail for a number of reasons,
/// such as insufficient permissions.
///
/// # Examples
///
/// ```no_run
Expand Down

0 comments on commit f2290c2

Please sign in to comment.