nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-05-14 02:49:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add links to the ErrorKind variants in errors of open

Browse Source
This commit is contained in:
Tobias Bucher 2017-06-28 13:43:56 +02:00
parent 71252d9b80
commit 2783d0f7da
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/libstd/fs.rs
View File

@ -654,25 +654,25 @@ impl OpenOptions {
/// ///
/// This function will return an error under a number of different /// This function will return an error under a number of different
/// circumstances. Some of these error conditions are listed here, together /// circumstances. Some of these error conditions are listed here, together
/// with their [`ErrorKind`]. The mapping to `ErrorKind`s is not part of /// with their [`ErrorKind`]. The mapping to [`ErrorKind`]s is not part of
/// the compatiblity contract of the function, especially the `Other` kind /// the compatiblity contract of the function, especially the `Other` kind
/// might change to more specific kinds in the future. /// might change to more specific kinds in the future.
/// ///
/// * `NotFound`: The specified file does not exist and neither `create` or /// * [`NotFound`]: The specified file does not exist and neither `create`
/// `create_new` is set, /// or `create_new` is set.
/// * `NotFound`: One of the directory components of the file path does not /// * [`NotFound`]: One of the directory components of the file path does
/// exist. /// not exist.
/// * `PermissionDenied`: The user lacks permission to get the specified /// * [`PermissionDenied`]: The user lacks permission to get the specified
/// access rights for the file. /// access rights for the file.
/// * `PermissionDenied`: The user lacks permission to open one of the /// * [`PermissionDenied`]: The user lacks permission to open one of the
/// directory components of the specified path. /// directory components of the specified path.
/// * `AlreadyExists`: `create_new` was specified and the file already /// * [`AlreadyExists`]: `create_new` was specified and the file already
/// exists. /// exists.
/// * `InvalidInput`: Invalid combinations of open options (truncate /// * [`InvalidInput`]: Invalid combinations of open options (truncate
/// without write access, no access mode set, etc.). /// without write access, no access mode set, etc.).
/// * `Other`: One of the directory components of the specified file path /// * [`Other`]: One of the directory components of the specified file path
/// was not, in fact, a directory. /// was not, in fact, a directory.
/// * `Other`: Filesystem-level errors: full disk, write permission /// * [`Other`]: Filesystem-level errors: full disk, write permission
/// requested on a read-only file system, exceeded disk quota, too many /// requested on a read-only file system, exceeded disk quota, too many
/// open files, too long filename, too many symbolic links in the /// open files, too long filename, too many symbolic links in the
/// specified path (Unix-like systems only), etc. /// specified path (Unix-like systems only), etc.
@ -686,6 +686,11 @@ impl OpenOptions {
/// ``` /// ```
/// ///
/// [`ErrorKind`]: ../io/enum.ErrorKind.html /// [`ErrorKind`]: ../io/enum.ErrorKind.html
/// [`AlreadyExists`]: ../io/enum.ErrorKind.html#variant.AlreadyExists
/// [`InvalidInput`]: ../io/enum.ErrorKind.html#variant.InvalidInput
/// [`NotFound`]: ../io/enum.ErrorKind.html#variant.NotFound
/// [`Other`]: ../io/enum.ErrorKind.html#variant.Other
/// [`PermissionDenied`]: ../io/enum.ErrorKind.html#variant.PermissionDenied
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> { pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
self._open(path.as_ref()) self._open(path.as_ref())