diff options
author | Geoff Shannon <geoffpshannon@gmail.com> | 2019-09-13 06:46:19 -1000 |
---|---|---|
committer | Carl Lerche <me@carllerche.com> | 2019-09-13 09:46:19 -0700 |
commit | c0a64d67ca27827e456298dc4e0f97fd9dffdda3 (patch) | |
tree | d8dae982622ced50d8300f132825ad9ab097877c /tokio-fs/src | |
parent | 6369d0f4f24e4e8bf1096ea684141d15a8962ba1 (diff) |
chore: fix docs links (#1523)
Diffstat (limited to 'tokio-fs/src')
-rw-r--r-- | tokio-fs/src/lib.rs | 1 | ||||
-rw-r--r-- | tokio-fs/src/read_dir.rs | 12 | ||||
-rw-r--r-- | tokio-fs/src/read_link.rs | 2 | ||||
-rw-r--r-- | tokio-fs/src/remove_dir.rs | 4 | ||||
-rw-r--r-- | tokio-fs/src/rename.rs | 4 |
5 files changed, 8 insertions, 15 deletions
diff --git a/tokio-fs/src/lib.rs b/tokio-fs/src/lib.rs index 155dce31..a805cf32 100644 --- a/tokio-fs/src/lib.rs +++ b/tokio-fs/src/lib.rs @@ -5,6 +5,7 @@ rust_2018_idioms, unreachable_pub )] +#![deny(intra_doc_link_resolution_failure)] #![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))] //! Asynchronous file and standard stream adaptation. diff --git a/tokio-fs/src/read_dir.rs b/tokio-fs/src/read_dir.rs index 6428dbda..54c9345d 100644 --- a/tokio-fs/src/read_dir.rs +++ b/tokio-fs/src/read_dir.rs @@ -16,9 +16,7 @@ use std::task::Poll; /// Returns a stream over the entries within a directory. /// -/// This is an async version of [`std::fs::read_dir`][std] -/// -/// [std]: https://doc.rust-lang.org/std/fs/fn.read_dir.html +/// This is an async version of [`std::fs::read_dir`](std::fs::read_dir) pub async fn read_dir<P>(path: P) -> io::Result<ReadDir> where P: AsRef<Path> + Send + 'static, @@ -43,8 +41,8 @@ where /// /// [`read_dir`]: fn.read_dir.html /// [`DirEntry`]: struct.DirEntry.html -/// [`Stream`]: ../futures/stream/trait.Stream.html -/// [`Err`]: https://doc.rust-lang.org/std/result/enum.Result.html#variant.Err +/// [`Stream`]: Stream +/// [`Err`]: std::result::Result::Err #[derive(Debug)] #[must_use = "streams do nothing unless polled"] pub struct ReadDir(State); @@ -86,14 +84,12 @@ impl Stream for ReadDir { /// /// [`ReadDir`]: struct.ReadDir.html /// -/// This is a specialized version of [`std::fs::DirEntry`][std] for usage from the +/// This is a specialized version of [`std::fs::DirEntry`](std::fs::DirEntry) for usage from the /// Tokio runtime. /// /// An instance of `DirEntry` represents an entry inside of a directory on the /// filesystem. Each entry can be inspected via methods to learn about the full /// path or possibly other metadata through per-platform extension traits. -/// -/// [std]: https://doc.rust-lang.org/std/fs/struct.DirEntry.html #[derive(Debug)] pub struct DirEntry(Arc<std::fs::DirEntry>); diff --git a/tokio-fs/src/read_link.rs b/tokio-fs/src/read_link.rs index 1cec06d5..e32574ab 100644 --- a/tokio-fs/src/read_link.rs +++ b/tokio-fs/src/read_link.rs @@ -7,7 +7,7 @@ use std::path::{Path, PathBuf}; /// /// This is an async version of [`std::fs::read_link`][std] /// -/// [std]: https://doc.rust-lang.org/std/fs/fn.read_link.html +/// [std]: std::fs::read_link pub async fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> { let path = path.as_ref().to_owned(); asyncify(move || std::fs::read_link(path)).await diff --git a/tokio-fs/src/remove_dir.rs b/tokio-fs/src/remove_dir.rs index 853e60b2..22c6ba3e 100644 --- a/tokio-fs/src/remove_dir.rs +++ b/tokio-fs/src/remove_dir.rs @@ -5,9 +5,7 @@ use std::path::Path; /// Removes an existing, empty directory. /// -/// This is an async version of [`std::fs::remove_dir`][std] -/// -/// [std]: https://doc.rust-lang.org/std/fs/fn.remove_dir.html +/// This is an async version of [`std::fs::remove_dir`](std::fs::remove_dir) pub async fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> { let path = path.as_ref().to_owned(); asyncify(move || std::fs::remove_dir(path)).await diff --git a/tokio-fs/src/rename.rs b/tokio-fs/src/rename.rs index 2429d7b8..16c96663 100644 --- a/tokio-fs/src/rename.rs +++ b/tokio-fs/src/rename.rs @@ -8,9 +8,7 @@ use std::path::Path; /// /// This will not work if the new name is on a different mount point. /// -/// This is an async version of [`std::fs::rename`][std] -/// -/// [std]: https://doc.rust-lang.org/std/fs/fn.rename.html +/// This is an async version of [`std::fs::rename`](std::fs::rename) pub async fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> { let from = from.as_ref().to_owned(); let to = to.as_ref().to_owned(); |