mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-30 02:33:55 +00:00
Add links to the ErrorKind
variants in errors of open
This commit is contained in:
parent
71252d9b80
commit
2783d0f7da
@ -654,25 +654,25 @@ impl OpenOptions {
|
||||
///
|
||||
/// This function will return an error under a number of different
|
||||
/// 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
|
||||
/// might change to more specific kinds in the future.
|
||||
///
|
||||
/// * `NotFound`: The specified file does not exist and neither `create` or
|
||||
/// `create_new` is set,
|
||||
/// * `NotFound`: One of the directory components of the file path does not
|
||||
/// exist.
|
||||
/// * `PermissionDenied`: The user lacks permission to get the specified
|
||||
/// * [`NotFound`]: The specified file does not exist and neither `create`
|
||||
/// or `create_new` is set.
|
||||
/// * [`NotFound`]: One of the directory components of the file path does
|
||||
/// not exist.
|
||||
/// * [`PermissionDenied`]: The user lacks permission to get the specified
|
||||
/// 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.
|
||||
/// * `AlreadyExists`: `create_new` was specified and the file already
|
||||
/// * [`AlreadyExists`]: `create_new` was specified and the file already
|
||||
/// exists.
|
||||
/// * `InvalidInput`: Invalid combinations of open options (truncate
|
||||
/// * [`InvalidInput`]: Invalid combinations of open options (truncate
|
||||
/// 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.
|
||||
/// * `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
|
||||
/// open files, too long filename, too many symbolic links in the
|
||||
/// specified path (Unix-like systems only), etc.
|
||||
@ -686,6 +686,11 @@ impl OpenOptions {
|
||||
/// ```
|
||||
///
|
||||
/// [`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")]
|
||||
pub fn open<P: AsRef<Path>>(&self, path: P) -> io::Result<File> {
|
||||
self._open(path.as_ref())
|
||||
|
Loading…
Reference in New Issue
Block a user