Enum futures::io::ErrorKind

[+] Show declaration

[+] Expand attributes
#[non_exhaustive]
pub enum ErrorKind {
    NotFound,
    PermissionDenied,
    ConnectionRefused,
    ConnectionReset,
    ConnectionAborted,
    NotConnected,
    AddrInUse,
    AddrNotAvailable,
    BrokenPipe,
    AlreadyExists,
    WouldBlock,
    InvalidInput,
    InvalidData,
    TimedOut,
    WriteZero,
    Interrupted,
    Other,
    UnexpectedEof,
}

[−] 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.

Variants (Non-exhaustive)

[+] This enum is marked as non-exhaustive

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.

NotFound

[−] Expand description

An entity was not found, often a file.

PermissionDenied

[−] Expand description

The operation lacked the necessary privileges to complete.

ConnectionRefused

[−] Expand description

The connection was refused by the remote server.

ConnectionReset

[−] Expand description

The connection was reset by the remote server.

ConnectionAborted

[−] Expand description

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

NotConnected

[−] Expand description

The network operation failed because it was not connected yet.

AddrInUse

[−] Expand description

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

AddrNotAvailable

[−] Expand description

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

BrokenPipe

[−] Expand description

The operation failed because a pipe was closed.

AlreadyExists

[−] Expand description

An entity already exists, often a file.

WouldBlock

[−] Expand description

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

InvalidInput

[−] Expand description

A parameter was incorrect.

InvalidData

[−] Expand description

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.

TimedOut

[−] Expand description

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

WriteZero

[−] Expand description

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

[−] Expand description

This operation was interrupted.

Interrupted operations can typically be retried.

Other

[−] Expand description

Any I/O error not part of this list.

UnexpectedEof

[−] Expand description

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.

Trait Implementations

impl Hash for ErrorKind[+]

[+] Show hidden undocumented items

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [−]

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

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

impl Eq for ErrorKind

impl From<ErrorKind> for Error[+]

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[−]

Converts an ErrorKind into an Error.

This conversion allocates a new error with a simple representation of error kind.

Examples

use std::io::{Error, ErrorKind};

let not_found = ErrorKind::NotFound;
let error = Error::from(not_found);
assert_eq!("entity not found", format!("{}", error));

impl Ord for ErrorKind[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &ErrorKind) -> Ordering[−]

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Debug for ErrorKind[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Copy for ErrorKind

impl PartialEq<ErrorKind> for ErrorKind[+]

[+] Show hidden undocumented items

fn eq(&self, other: &ErrorKind) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl Clone for ErrorKind[+]

[+] Show hidden undocumented items

fn clone(&self) -> ErrorKind[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl PartialOrd<ErrorKind> for ErrorKind[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &ErrorKind) -> Option<Ordering>[−]

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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