Remove now-redundant documentation URLs.

Author: sunfishcode

cap-async-std/src/fs/dir.rs

@@ -37,7 +37,6 @@ use {
 /// absolute paths don't interoperate well with the capability model.
 ///
 /// [functions in `async_std::fs`]: https://docs.rs/async-std/latest/async_std/fs/index.html#functions
-/// [`async_std::fs::File`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html
 pub struct Dir {
     std_file: fs::File,
 }
@@ -67,8 +66,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::File::open`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::File::open`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.open
     #[inline]
     pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
         self.open_with(path, OpenOptions::new().read(true))
@@ -80,8 +77,6 @@ impl Dir {
     ///
     /// Instead of being a method on `OpenOptions`, this is a method on `Dir`,
     /// and it only accesses paths relative to `self`.
-    ///
-    /// [`async_std::fs::OpenOptions::open`]: https://docs.rs/async-std/latest/async_std/fs/struct.OpenOptions.html#method.open
     #[inline]
     pub fn open_with<P: AsRef<Path>>(&self, path: P, options: &OpenOptions) -> io::Result<File> {
         let file = self.std_file.as_file_view();
@@ -112,8 +107,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::create_dir`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::create_dir`]: https://docs.rs/async-std/latest/async_std/fs/fn.create_dir.html
     #[inline]
     pub fn create_dir<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         self._create_dir_one(path.as_ref(), &DirOptions::new())
@@ -123,8 +116,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::create_dir_all`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::create_dir_all`]: https://docs.rs/async-std/latest/async_std/fs/fn.create_dir_all.html
     #[inline]
     pub fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         self._create_dir_all(path.as_ref(), &DirOptions::new())
@@ -133,8 +124,6 @@ impl Dir {
     /// Creates the specified directory with the options configured in this builder.
     ///
     /// This corresponds to [`async_std::fs::DirBuilder::create`].
-    ///
-    /// [`async_std::fs::DirBuilder::create`]: https://docs.rs/async-std/latest/async_std/fs/struct.DirBuilder.html#method.create
     #[inline]
     pub fn create_dir_with<P: AsRef<Path>>(
         &self,
@@ -185,8 +174,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::File::create`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::File::create`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.create
     #[inline]
     pub fn create<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
         self.open_with(
@@ -200,8 +187,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::canonicalize`], but instead of returning an
     /// absolute path, returns a path relative to the directory represented by `self`.
-    ///
-    /// [`async_std::fs::canonicalize`]: https://docs.rs/async-std/latest/async_std/fs/fn.canonicalize.html
     #[inline]
     pub fn canonicalize<P: AsRef<Path>>(&self, path: P) -> io::Result<PathBuf> {
         let file = self.std_file.as_file_view();
@@ -213,8 +198,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::copy`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::copy`]: https://docs.rs/async-std/latest/async_std/fs/fn.copy.html
     #[inline]
     pub async fn copy<P: AsRef<Path>, Q: AsRef<Path>>(
         &self,
@@ -236,8 +219,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::hard_link`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::hard_link`]: https://docs.rs/async-std/latest/async_std/fs/fn.hard_link.html
     #[inline]
     pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(
         &self,
@@ -259,8 +240,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::metadata`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::metadata`]: https://docs.rs/async-std/latest/async_std/fs/fn.metadata.html
     #[inline]
     pub fn metadata<P: AsRef<Path>>(&self, path: P) -> io::Result<Metadata> {
         let file = self.std_file.as_file_view();
@@ -278,8 +257,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::read_dir`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::read_dir`]: https://docs.rs/async-std/latest/async_std/fs/fn.read_dir.html
     #[inline]
     pub fn read_dir<P: AsRef<Path>>(&self, path: P) -> io::Result<ReadDir> {
         let file = self.std_file.as_file_view();
@@ -290,8 +267,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::read`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::read`]: https://docs.rs/async-std/latest/async_std/fs/fn.read.html
     #[inline]
     pub async fn read<P: AsRef<Path>>(&self, path: P) -> io::Result<Vec<u8>> {
         use async_std::prelude::*;
@@ -305,8 +280,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::read_link`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::read_link`]: https://docs.rs/async-std/latest/async_std/fs/fn.read_link.html
     #[inline]
     pub fn read_link<P: AsRef<Path>>(&self, path: P) -> io::Result<PathBuf> {
         let file = self.std_file.as_file_view();
@@ -317,8 +290,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::read_to_string`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::read_to_string`]: https://docs.rs/async-std/latest/async_std/fs/fn.read_to_string.html
     #[inline]
     pub async fn read_to_string<P: AsRef<Path>>(&self, path: P) -> io::Result<String> {
         use async_std::prelude::*;
@@ -331,8 +302,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::remove_dir`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::remove_dir`]: https://docs.rs/async-std/latest/async_std/fs/fn.remove_dir.html
     #[inline]
     pub fn remove_dir<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         let file = self.std_file.as_file_view();
@@ -343,8 +312,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::remove_dir_all`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::remove_dir_all`]: https://docs.rs/async-std/latest/async_std/fs/fn.remove_dir_all.html
     #[inline]
     pub async fn remove_dir_all<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         let file = self.std_file.as_file_view();
@@ -376,8 +343,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::remove_file`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::remove_file`]: https://docs.rs/async-std/latest/async_std/fs/fn.remove_file.html
     #[inline]
     pub fn remove_file<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         let file = self.std_file.as_file_view();
@@ -388,8 +353,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::rename`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::rename`]: https://docs.rs/async-std/latest/async_std/fs/fn.rename.html
     #[inline]
     pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(
         &self,
@@ -412,8 +375,6 @@ impl Dir {
     /// This corresponds to [`async_std::fs::set_permissions`], but only accesses paths
     /// relative to `self`. Also, on some platforms, this function may fail if the
     /// file or directory cannot be opened for reading or writing first.
-    ///
-    /// [`async_std::fs::set_permissions`]: https://docs.rs/async-std/latest/async_std/fs/fn.set_permissions.html
     pub fn set_permissions<P: AsRef<Path>>(&self, path: P, perm: Permissions) -> io::Result<()> {
         let file = self.std_file.as_file_view();
         set_permissions(&file, path.as_ref().as_ref(), perm)
@@ -423,8 +384,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::symlink_metadata`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::symlink_metadata`]: https://docs.rs/async-std/latest/async_std/fs/fn.symlink_metadata.html
     #[inline]
     pub fn symlink_metadata<P: AsRef<Path>>(&self, path: P) -> io::Result<Metadata> {
         let file = self.std_file.as_file_view();
@@ -435,8 +394,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::fs::write`], but only accesses paths
     /// relative to `self`.
-    ///
-    /// [`async_std::fs::write`]: https://docs.rs/async-std/latest/async_std/fs/fn.write.html
     #[inline]
     pub async fn write<P: AsRef<Path>, C: AsRef<[u8]>>(
         &self,
@@ -593,8 +550,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::path::Path::exists`], but only
     /// accesses paths relative to `self`.
-    ///
-    /// [`async_std::path::Path::exists`]: https://docs.rs/async-std/latest/async_std/path/struct.Path.html#method.exists
     #[inline]
     pub fn exists<P: AsRef<Path>>(&self, path: P) -> bool {
         self.metadata(path).is_ok()
@@ -604,8 +559,6 @@ impl Dir {
     ///
     /// This corresponds to [`async_std::path::Path::is_file`], but only
     /// accesses paths relative to `self`.
-    ///
-    /// [`async_std::path::Path::is_file`]: https://docs.rs/async-std/latest/async_std/path/struct.Path.html#method.is_file
     #[inline]
     pub fn is_file<P: AsRef<Path>>(&self, path: P) -> bool {
         self.metadata(path).map(|m| m.is_file()).unwrap_or(false)
@@ -616,8 +569,6 @@ impl Dir {
     /// This is similar to [`async_std::path::Path::is_dir`] in that it checks if `path` relative to
     /// `Dir` is a directory. This function will traverse symbolic links to query information about
     /// the destination file. In case of broken symbolic links, this will return `false`.
-    ///
-    /// [`async_std::path::Path::is_dir`]: https://docs.rs/async-std/latest/async_std/path/struct.Path.html#method.is_dir
     #[inline]
     pub fn is_dir<P: AsRef<Path>>(&self, path: P) -> bool {
         self.metadata(path).map(|m| m.is_dir()).unwrap_or(false)

cap-async-std/src/fs/dir_entry.rs

@@ -21,8 +21,6 @@ use std::{ffi::OsString, fmt};
 /// Note that there is no `from_std` method, as `async_std::fs::DirEntry` doesn't
 /// provide a way to construct a `DirEntry` without opening directories by
 /// ambient paths.
-///
-/// [`async_std::fs::DirEntry`]: https://docs.rs/async-std/latest/async_std/fs/struct.DirEntry.html
 pub struct DirEntry {
     pub(crate) inner: cap_primitives::fs::DirEntry,
 }
@@ -64,8 +62,6 @@ impl DirEntry {
     /// Returns the metadata for the file that this entry points at.
     ///
     /// This corresponds to [`async_std::fs::DirEntry::metadata`].
-    ///
-    /// [`async_std::fs::DirEntry::metadata`]: https://docs.rs/async-std/latest/async_std/fs/struct.DirEntry.html#method.metadata
     #[inline]
     pub fn metadata(&self) -> io::Result<Metadata> {
         // TODO: Make this async.
@@ -75,8 +71,6 @@ impl DirEntry {
     /// Returns the file type for the file that this entry points at.
     ///
     /// This corresponds to [`async_std::fs::DirEntry::file_type`].
-    ///
-    /// [`async_std::fs::DirEntry::file_type`]: https://docs.rs/async-std/latest/async_std/fs/struct.DirEntry.html#method.file_type
     #[inline]
     pub async fn file_type(&self) -> io::Result<FileType> {
         // TODO: Make this actually async.
@@ -86,8 +80,6 @@ impl DirEntry {
     /// Returns the bare file name of this directory entry without any other leading path component.
     ///
     /// This corresponds to [`async_std::fs::DirEntry::file_name`].
-    ///
-    /// [`async_std::fs::DirEntry::file_name`]: https://docs.rs/async-std/latest/async_std/fs/struct.DirEntry.html#method.file_name
     #[inline]
     pub fn file_name(&self) -> OsString {
         self.inner.file_name()

cap-async-std/src/fs/file.rs

@@ -22,10 +22,9 @@ use unsafe_io::AsUnsafeFile;
 /// a file, you must first obtain a [`Dir`] containing the path, and then call
 /// [`Dir::open`] or [`Dir::create`].
 ///
-/// [`async_std::fs::File`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html
-/// [`Dir`]: struct.Dir.html
-/// [`Dir::open`]: struct.Dir.html#method.open
-/// [`Dir::create`]: struct.Dir.html#method.create
+/// [`Dir`]: crate::fs::Dir
+/// [`Dir::open`]: crate::fs::Dir::open
+/// [`Dir::create`]: crate::fs::Dir::create
 pub struct File {
     pub(crate) std: fs::File,
 }
@@ -53,8 +52,6 @@ impl File {
     /// Attempts to sync all OS-internal metadata to disk.
     ///
     /// This corresponds to [`async_std::fs::File::sync_all`].
-    ///
-    /// [`async_std::fs::File::sync_all`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.sync_all
     #[inline]
     pub async fn sync_all(&self) -> io::Result<()> {
         self.std.sync_all().await
@@ -64,8 +61,6 @@ impl File {
     /// file metadata to a filesystem.
     ///
     /// This corresponds to [`async_std::fs::File::sync_data`].
-    ///
-    /// [`async_std::fs::File::sync_data`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.sync_data
     #[inline]
     pub async fn sync_data(&self) -> io::Result<()> {
         self.std.sync_data().await
@@ -75,8 +70,6 @@ impl File {
     /// to become size.
     ///
     /// This corresponds to [`async_std::fs::File::set_len`].
-    ///
-    /// [`async_std::fs::File::set_len`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.set_len
     #[inline]
     pub async fn set_len(&self, size: u64) -> io::Result<()> {
         self.std.set_len(size).await
@@ -85,8 +78,6 @@ impl File {
     /// Queries metadata about the underlying file.
     ///
     /// This corresponds to [`async_std::fs::File::metadata`].
-    ///
-    /// [`async_std::fs::File::metadata`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.metadata
     #[inline]
     pub fn metadata(&self) -> io::Result<Metadata> {
         let sync = self.std.as_file_view();
@@ -98,8 +89,6 @@ impl File {
     /// Changes the permissions on the underlying file.
     ///
     /// This corresponds to [`async_std::fs::File::set_permissions`].
-    ///
-    /// [`async_std::fs::File::set_permissions`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html#method.set_permissions
     #[inline]
     pub async fn set_permissions(&self, perm: Permissions) -> io::Result<()> {
         let sync = self.std.as_file_view();

cap-async-std/src/fs/mod.rs

@@ -21,10 +21,7 @@
 //! `canonicalize`, `read_link`, `read_dir`, `metadata`, and `symlink_metadata`
 //! functions.
 //!
-//! [`async_std::fs`]: https://docs.rs/async-std/latest/async_std/fs/
 //! [`async_std::fs`'s free functions]: https://docs.rs/async-std/latest/async_std/fs/#functions
-//! [`async_std::fs::File`]: https://docs.rs/async-std/latest/async_std/fs/struct.File.html
-//! [`Dir`]: struct.Dir.html
 
 mod dir;
 mod dir_entry;

cap-async-std/src/fs/read_dir.rs

@@ -9,8 +9,6 @@ use std::fmt;
 /// Note that there is no `from_std` method, as `async_std::fs::ReadDir` doesn't
 /// provide a way to construct a `ReadDir` without opening directories by
 /// ambient paths.
-///
-/// [`async_std::fs::ReadDir`]: https://docs.rs/async-std/latest/async_std/fs/struct.ReadDir.html
 pub struct ReadDir {
     pub(crate) inner: cap_primitives::fs::ReadDir,
 }