Skip to content

Commit bb9ac1b

Browse files
committed
Document that create_dir_all calls mkdir/CreateDirW multiple times
Also mention that there might be leftover directories in the error case.
1 parent 05d6270 commit bb9ac1b

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

Diff for: std/src/fs.rs

+7-3
Original file line numberDiff line numberDiff line change
@@ -2258,7 +2258,7 @@ pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
22582258
/// # Platform-specific behavior
22592259
///
22602260
/// This function currently corresponds to the `mkdir` function on Unix
2261-
/// and the `CreateDirectory` function on Windows.
2261+
/// and the `CreateDirectoryW` function on Windows.
22622262
/// Note that, this [may change in the future][changes].
22632263
///
22642264
/// [changes]: io#platform-specific-behavior
@@ -2298,10 +2298,14 @@ pub fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
22982298
/// Recursively create a directory and all of its parent components if they
22992299
/// are missing.
23002300
///
2301+
/// If this function returns an error, some of the parent components might have
2302+
/// been created already.
2303+
///
23012304
/// # Platform-specific behavior
23022305
///
2303-
/// This function currently corresponds to the `mkdir` function on Unix
2304-
/// and the `CreateDirectory` function on Windows.
2306+
/// This function currently corresponds to multiple calls to the `mkdir`
2307+
/// function on Unix and the `CreateDirectoryW` function on Windows.
2308+
///
23052309
/// Note that, this [may change in the future][changes].
23062310
///
23072311
/// [changes]: io#platform-specific-behavior

0 commit comments

Comments
 (0)