dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add note about `AlreadyExists` to `create_new`

This commit is contained in:
anatawa12 2024-05-06 09:52:13 +09:00
parent 9c9b568792
commit ab066ae329
No known key found for this signature in database
GPG Key ID: 9CA909848B8E4EA6
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
library/std/src/fs.rs
View File

@ -408,6 +408,7 @@ impl File {
///
/// This function will create a file if it does not exist, or return an error if it does. This
/// way, if the call succeeds, the file returned is guaranteed to be new.
/// If a file exists at the target location before, creating file will fail with [`AlreadyExists`].
///
/// This option is useful because it is atomic. Otherwise between checking whether a file
/// exists and creating a new one, the file may have been created by another process (a TOCTOU
@ -416,6 +417,8 @@ impl File {
/// This can also be written using
/// `File::options().read(true).write(true).create_new(true).open(...)`.
///
/// [`AlreadyExists`]: crate::io::ErrorKind::AlreadyExists
///
/// # Examples
///
/// ```no_run
@ -1071,6 +1074,7 @@ impl OpenOptions {
///
/// No file is allowed to exist at the target location, also no (dangling) symlink. In this
/// way, if the call succeeds, the file returned is guaranteed to be new.
/// If a file exists at the target location before, creating file will fail with [`AlreadyExists`].
///
/// This option is useful because it is atomic. Otherwise between checking
/// whether a file exists and creating a new one, the file may have been
@ -1084,6 +1088,7 @@ impl OpenOptions {
///
/// [`.create()`]: OpenOptions::create
/// [`.truncate()`]: OpenOptions::truncate
/// [`AlreadyExists`]: io::ErrorKind::AlreadyExists
///
/// # Examples
///