diff options
| author | kennytm <kennytm@gmail.com> | 2018-09-07 13:47:06 +0800 |
|---|---|---|
| committer | kennytm <kennytm@gmail.com> | 2018-09-07 15:26:30 +0800 |
| commit | 654c5788aa2130acfc89a0883952c6de4bddac95 (patch) | |
| tree | fa95838dbea468be2ae89983e1248490eb71edbe /src/libstd | |
| parent | 846a0bd1b92c7b3db112bfc9677c32e0976fb0cc (diff) | |
| parent | 5f198a5e442bfef37e752594a6d037e7e143e42f (diff) | |
| download | rust-654c5788aa2130acfc89a0883952c6de4bddac95.tar.gz rust-654c5788aa2130acfc89a0883952c6de4bddac95.zip | |
Rollup merge of #53376 - frewsxcv:frewsxcv-copy, r=GuillaumeGomez
Cross reference io::copy and fs::copy in docs. Fixes https://github.com/rust-lang/rust/issues/52524.
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/fs.rs | 6 | ||||
| -rw-r--r-- | src/libstd/io/util.rs | 5 |
2 files changed, 11 insertions, 0 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs index e177d4a988a..f14d55cb2d3 100644 --- a/src/libstd/fs.rs +++ b/src/libstd/fs.rs @@ -1566,6 +1566,12 @@ pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> /// On success, the total number of bytes copied is returned and it is equal to /// the length of the `to` file as reported by `metadata`. /// +/// If you’re wanting to copy the contents of one file to another and you’re +/// working with [`File`]s, see the [`io::copy`] function. +/// +/// [`io::copy`]: ../io/fn.copy.html +/// [`File`]: ./struct.File.html +/// /// # Platform-specific behavior /// /// This function currently corresponds to the `open` function in Unix diff --git a/src/libstd/io/util.rs b/src/libstd/io/util.rs index 33f741dbc38..371e5b21c13 100644 --- a/src/libstd/io/util.rs +++ b/src/libstd/io/util.rs @@ -23,6 +23,11 @@ use mem; /// On success, the total number of bytes that were copied from /// `reader` to `writer` is returned. /// +/// If you’re wanting to copy the contents of one file to another and you’re +/// working with filesystem paths, see the [`fs::copy`] function. +/// +/// [`fs::copy`]: ../fs/fn.copy.html +/// /// # Errors /// /// This function will return an error immediately if any call to `read` or |