#[non_exhaustive]
pub enum ErrorKind {
Show 41 variants NotFound,
PermissionDenied,
ConnectionRefused,
ConnectionReset,
HostUnreachable,
NetworkUnreachable,
ConnectionAborted,
NotConnected,
AddrInUse,
AddrNotAvailable,
NetworkDown,
BrokenPipe,
AlreadyExists,
WouldBlock,
NotADirectory,
IsADirectory,
DirectoryNotEmpty,
ReadOnlyFilesystem,
FilesystemLoop,
StaleNetworkFileHandle,
InvalidInput,
InvalidData,
TimedOut,
WriteZero,
StorageFull,
NotSeekable,
QuotaExceeded,
FileTooLarge,
ResourceBusy,
ExecutableFileBusy,
Deadlock,
CrossesDevices,
TooManyLinks,
InvalidFilename,
ArgumentListTooLong,
Interrupted,
Unsupported,
UnexpectedEof,
OutOfMemory,
InProgress,
Other,
}
Expand description
A list specifying general categories of I/O error.
This list is intended to grow over time and it is not recommended to exhaustively match against it.
It is used with the io::Error
type.
ErrorKind
In application code, use match
for the ErrorKind
values you are expecting; use _
to match âall other errorsâ.
In comprehensive and thorough tests that want to verify that a test doesnât return any known incorrect error kind, you may want to cut-and-paste the current full list of errors from here into your test code, and then match _
as the correct case. This seems counterintuitive, but it will make your tests more robust. In particular, if you want to verify that your code does produce an unrecognized error kind, the robust solution is to check for all the recognized error kinds and fail in those cases.
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§1.0.0An entity was not found, often a file.
§1.0.0The operation lacked the necessary privileges to complete.
§1.0.0The connection was refused by the remote server.
§1.0.0The connection was reset by the remote server.
§1.83.0The remote host is not reachable.
§1.83.0The network containing the remote host is not reachable.
§1.0.0The connection was aborted (terminated) by the remote server.
§1.0.0The network operation failed because it was not connected yet.
§1.0.0A socket address could not be bound because the address is already in use elsewhere.
§1.0.0A nonexistent interface was requested or the requested address was not local.
§1.83.0The systemâs networking is down.
§1.0.0The operation failed because a pipe was closed.
§1.0.0An entity already exists, often a file.
§1.0.0The operation needs to block to complete, but the blocking operation was requested to not occur.
§1.83.0A filesystem object is, unexpectedly, not a directory.
For example, a filesystem path was specified where one of the intermediate directory components was, in fact, a plain file.
§1.83.0The filesystem object is, unexpectedly, a directory.
A directory was specified when a non-directory was expected.
§1.83.0A non-empty directory was specified where an empty directory was expected.
§1.83.0The filesystem or storage medium is read-only, but a write operation was attempted.
§ ð¬This is a nightly-only experimental API. (io_error_more
#86442)
Loop in the filesystem or IO subsystem; often, too many levels of symbolic links.
There was a loop (or excessively long chain) resolving a filesystem object or file IO object.
On Unix this is usually the result of a symbolic link loop; or, of exceeding the system-specific limit on the depth of symlink traversal.
§1.83.0Stale network file handle.
With some network filesystems, notably NFS, an open file (or directory) can be invalidated by problems with the network or server.
§1.0.0A parameter was incorrect.
§1.2.0Data not valid for the operation were encountered.
Unlike InvalidInput
, this typically means that the operation parameters were valid, however the error was caused by malformed input data.
For example, a function that reads a file into a string will error with InvalidData
if the fileâs contents are not valid UTF-8.
The I/O operationâs timeout expired, causing it to be canceled.
§1.0.0An error returned when an operation could not be completed because a call to write
returned Ok(0)
.
This typically means that an operation could only succeed if it wrote a particular number of bytes but only a smaller number of bytes could be written.
§1.83.0The underlying storage (typically, a filesystem) is full.
This does not include out of quota errors.
§1.83.0Seek on unseekable file.
Seeking was attempted on an open file handle which is not suitable for seeking - for example, on Unix, a named pipe opened with File::open
.
Filesystem quota or some other kind of quota was exceeded.
§1.83.0File larger than allowed or supported.
This might arise from a hard limit of the underlying filesystem or file access API, or from an administratively imposed resource limitation. Simple disk full, and out of quota, have their own errors.
§1.83.0Resource is busy.
§1.83.0Executable file is busy.
An attempt was made to write to a file which is also in use as a running program. (Not all operating systems detect this situation.)
§1.83.0Deadlock (avoided).
A file locking operation would result in deadlock. This situation is typically detected, if at all, on a best-effort basis.
§1.85.0Cross-device or cross-filesystem (hard) link or rename.
§1.83.0Too many (hard) links to the same filesystem object.
The filesystem does not support making so many hardlinks to the same file.
§1.87.0A filename was invalid.
This error can also occur if a length limit for a name was exceeded.
§1.83.0Program argument list too long.
When trying to run an external program, a system or process limit on the size of the arguments would have been exceeded.
§1.0.0This operation was interrupted.
Interrupted operations can typically be retried.
§1.53.0This operation is unsupported on this platform.
This means that the operation can never succeed.
§1.6.0An error returned when an operation could not be completed because an âend of fileâ was reached prematurely.
This typically means that an operation could only succeed if it read a particular number of bytes but only a smaller number of bytes could be read.
§1.54.0An operation could not be completed, because it failed to allocate enough memory.
§ ð¬This is a nightly-only experimental API. (io_error_inprogress
#130840)
The operation was partially successful and needs to be checked later on due to not blocking.
§1.0.0A custom error that does not fall under any other I/O error kind.
This can be used to construct your own Error
s that do not match any ErrorKind
.
This ErrorKind
is not used by the standard library.
Errors from the standard library that do not fall under any of the I/O error kinds cannot be match
ed on, and will only match a wildcard (_
) pattern. New ErrorKind
s might be added in the future for some of those.
Shows a human-readable description of the ErrorKind
.
This is similar to impl Display for Error
, but doesnât require first converting to Error.
use std::io::ErrorKind;
assert_eq!("entity not found", ErrorKind::NotFound.to_string());
1.14.0 · Source§
Intended for use for errors not exposed to the user, where allocating onto the heap (for normal construction via Error::new) is too costly.
Source§Converts an ErrorKind
into an Error
.
This conversion creates a new error with a simple representation of error kind.
§Examplesuse std::io::{Error, ErrorKind};
let not_found = ErrorKind::NotFound;
let error = Error::from(not_found);
assert_eq!("entity not found", format!("{error}"));
1.0.0 · Source§ 1.0.0 · Source§ 1.0.0 · Source§ Source§
Tests for self
and other
values to be equal, and is used by ==
.
Tests for !=
. The default implementation is almost always sufficient, and should not be overridden without very good reason.
This method returns an ordering between
self
and
other
values if one exists.
Read more 1.0.0 · Source§Tests less than (for
self
and
other
) and is used by the
<
operator.
Read more 1.0.0 · Source§Tests less than or equal to (for
self
and
other
) and is used by the
<=
operator.
Read more 1.0.0 · Source§Tests greater than (for
self
and
other
) and is used by the
>
operator.
Read more 1.0.0 · Source§Tests greater than or equal to (for
self
and
other
) and is used by the
>=
operator.
Read more 1.0.0 · Source§ 1.0.0 · Source§ 1.0.0 · Source§RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4