]> git.lizzy.rs Git - rust.git/commitdiff
Reword OpenOptions::{create, create_new} doc.
authorjumbatm <jumbatm@gmail.com>
Wed, 19 Feb 2020 09:57:32 +0000 (19:57 +1000)
committerjumbatm <jumbatm@gmail.com>
Wed, 19 Feb 2020 09:57:32 +0000 (19:57 +1000)
src/libstd/fs.rs

index cff7bbe5ef183a58ebde5e4720d9994666a0dccc..09be3f1305052d4df072733e24fb151796e6fac8 100644 (file)
@@ -844,10 +844,7 @@ pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions {
         self
     }
 
-    /// Sets the option for creating a new file.
-    ///
-    /// This option indicates whether a new file will be created if the file
-    /// does not yet already exist.
+    /// Sets the option to create a new file, or open it if it already exists.
     ///
     /// In order for the file to be created, [`write`] or [`append`] access must
     /// be used.
@@ -868,11 +865,10 @@ pub fn create(&mut self, create: bool) -> &mut OpenOptions {
         self
     }
 
-    /// Sets the option to always create a new file.
+    /// Sets the option to create a new file, failing if it already exists.
     ///
-    /// This option indicates whether a new file will be created.
-    /// No file is allowed to exist at the target location, also no (dangling)
-    /// symlink.
+    /// 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.
     ///
     /// 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