std::io::ErrorKind - Rust
Description: API documentation for the Rust `ErrorKind` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, ErrorKind

# Enum std::io::ErrorKind 1.0.0 [−] [src]

    pub enum ErrorKind {
        NotFound,
        PermissionDenied,
        ConnectionRefused,
        ConnectionReset,
        ConnectionAborted,
        NotConnected,
        AddrInUse,
        AddrNotAvailable,
        BrokenPipe,
        AlreadyExists,
        WouldBlock,
        InvalidInput,
        InvalidData,
        TimedOut,
        WriteZero,
        Interrupted,
        Other,
        UnexpectedEof,
        // some variants omitted
    }

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.

## Variants

`NotFound`

An entity was not found, often a file.

`PermissionDenied`

The operation lacked the necessary privileges to complete.

`ConnectionRefused`

The connection was refused by the remote server.

`ConnectionReset`

The connection was reset by the remote server.

`ConnectionAborted`

The connection was aborted (terminated) by the remote server.

`NotConnected`

The network operation failed because it was not connected yet.

`AddrInUse`

A socket address could not be bound because the address is already in use elsewhere.

`AddrNotAvailable`

A nonexistent interface was requested or the requested address was not local.

`BrokenPipe`

The operation failed because a pipe was closed.

`AlreadyExists`

An entity already exists, often a file.

`WouldBlock`

The operation needs to block to complete, but the blocking operation was requested to not occur.

`InvalidInput`

A parameter was incorrect.

`InvalidData`

Data 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.

1.2.0
`TimedOut`

The I/O operation's timeout expired, causing it to be canceled.

`WriteZero`

An 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.

`Interrupted`

This operation was interrupted.

Interrupted operations can typically be retried.

`Other`

Any I/O error not part of this list.

`UnexpectedEof`

An 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.6.0

## Trait Implementations

### `impl Clone for ErrorKind`
[src]

#### `fn clone(&self) -> ErrorKind`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
[src]

Performs copy-assignment from `source`. Read more

### `impl Copy for ErrorKind`
[src]

### `impl Debug for ErrorKind`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl Eq for ErrorKind`
[src]

### `impl Hash for ErrorKind`
[src]

#### `fn hash<__H: Hasher>(&self, __arg_0: &mut __H)`
[src]

Feeds this value into the given [`Hasher`]. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,`
1.3.0
[src]

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl Ord for ErrorKind`
[src]

#### `fn cmp(&self, __arg_0: &ErrorKind) -> Ordering`
[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `fn max(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the maximum of two values. Read more

#### `fn min(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the minimum of two values. Read more

### `impl PartialEq for ErrorKind`
[src]

#### `fn eq(&self, __arg_0: &ErrorKind) -> bool`
[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Rhs) -> bool`
[src]

This method tests for `!=`.

### `impl PartialOrd for ErrorKind`
[src]

#### `fn partial_cmp(&self, __arg_0: &ErrorKind) -> Option<Ordering>`
[src]

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Rhs) -> bool`
[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Rhs) -> bool`
[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Rhs) -> bool`
[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Rhs) -> bool`
[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl From<ErrorKind> for Error`
1.14.0
[src]

Intended for use for errors not exposed to the user, where allocating onto the heap (for normal construction via Error::new) is too costly.

#### `fn from(kind: ErrorKind) -> Error`
[src]

Performs the conversion.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)