Skip to content

Commit 2783d0f

Browse files
committed
Add links to the ErrorKind variants in errors of open
1 parent 71252d9 commit 2783d0f

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

Diff for: src/libstd/fs.rs

+16-11
Original file line numberDiff line numberDiff line change
@@ -654,25 +654,25 @@ impl OpenOptions {
654654
///
655655
/// This function will return an error under a number of different
656656
/// circumstances. Some of these error conditions are listed here, together
657-
/// with their [`ErrorKind`]. The mapping to `ErrorKind`s is not part of
657+
/// with their [`ErrorKind`]. The mapping to [`ErrorKind`]s is not part of
658658
/// the compatiblity contract of the function, especially the `Other` kind
659659
/// might change to more specific kinds in the future.
660660
///
661-
/// * `NotFound`: The specified file does not exist and neither `create` or
662-
/// `create_new` is set,
663-
/// * `NotFound`: One of the directory components of the file path does not
664-
/// exist.
665-
/// * `PermissionDenied`: The user lacks permission to get the specified
661+
/// * [`NotFound`]: The specified file does not exist and neither `create`
662+
/// or `create_new` is set.
663+
/// * [`NotFound`]: One of the directory components of the file path does
664+
/// not exist.
665+
/// * [`PermissionDenied`]: The user lacks permission to get the specified
666666
/// access rights for the file.
667-
/// * `PermissionDenied`: The user lacks permission to open one of the
667+
/// * [`PermissionDenied`]: The user lacks permission to open one of the
668668
/// directory components of the specified path.
669-
/// * `AlreadyExists`: `create_new` was specified and the file already
669+
/// * [`AlreadyExists`]: `create_new` was specified and the file already
670670
/// exists.
671-
/// * `InvalidInput`: Invalid combinations of open options (truncate
671+
/// * [`InvalidInput`]: Invalid combinations of open options (truncate
672672
/// without write access, no access mode set, etc.).
673-
/// * `Other`: One of the directory components of the specified file path
673+
/// * [`Other`]: One of the directory components of the specified file path
674674
/// was not, in fact, a directory.
675-
/// * `Other`: Filesystem-level errors: full disk, write permission
675+
/// * [`Other`]: Filesystem-level errors: full disk, write permission
676676
/// requested on a read-only file system, exceeded disk quota, too many
677677
/// open files, too long filename, too many symbolic links in the
678678
/// specified path (Unix-like systems only), etc.
@@ -686,6 +686,11 @@ impl OpenOptions {
686686
/// ```
687687
///
688688
/// [`ErrorKind`]: ../io/enum.ErrorKind.html
689+
/// [`AlreadyExists`]: ../io/enum.ErrorKind.html#variant.AlreadyExists
690+
/// [`InvalidInput`]: ../io/enum.ErrorKind.html#variant.InvalidInput
691+
/// [`NotFound`]: ../io/enum.ErrorKind.html#variant.NotFound
692+
/// [`Other`]: ../io/enum.ErrorKind.html#variant.Other
693+
/// [`PermissionDenied`]: ../io/enum.ErrorKind.html#variant.PermissionDenied
689694
#[stable(feature = "rust1", since = "1.0.0")]
690695
pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
691696
self._open(path.as_ref())

0 commit comments

Comments
 (0)