about summary refs log tree commit diff
diff options
context:
space:
mode:
authorYuki Okushi <jtitor@2k36.org>2022-07-16 17:53:00 +0900
committerGitHub <noreply@github.com>2022-07-16 17:53:00 +0900
commit06eb90ef634797ee071f8a1653c2f6cc950a2ed5 (patch)
tree5bf492c25e0d4faf5dd3dccc9914a45d49d03805
parentbf9ed994960cee0443a39e952f1a8b59d3f48a40 (diff)
parent07a0fd2c1ee79faafafed2cfe60e640ca106fdb4 (diff)
downloadrust-06eb90ef634797ee071f8a1653c2f6cc950a2ed5.tar.gz
rust-06eb90ef634797ee071f8a1653c2f6cc950a2ed5.zip
Rollup merge of #98662 - LucasDumont:document_fs_write, r=thomcc
Add std::fs::write documentation precision

Fixes #97947.

As mentioned in #97947, the documentation is updated
-rw-r--r--library/std/src/fs.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs
index f46997b807a..d799776548a 100644
--- a/library/std/src/fs.rs
+++ b/library/std/src/fs.rs
@@ -295,6 +295,9 @@ pub fn read_to_string<P: AsRef<Path>>(path: P) -> io::Result<String> {
 /// This function will create a file if it does not exist,
 /// and will entirely replace its contents if it does.
 ///
+/// Depending on the platform, this function may fail if the
+/// full directory path does not exist.
+///
 /// This is a convenience function for using [`File::create`] and [`write_all`]
 /// with fewer imports.
 ///
@@ -349,6 +352,9 @@ impl File {
     /// This function will create a file if it does not exist,
     /// and will truncate it if it does.
     ///
+    /// Depending on the platform, this function may fail if the
+    /// full directory path does not exist.
+    ///
     /// See the [`OpenOptions::open`] function for more details.
     ///
     /// # Examples