Enum ErrorCode

#[repr(u8)]
pub enum ErrorCode {
    Unknown = 0,
    AccessDenied = 1,
    NotSupported = 2,
    InvalidArgument = 3,
    OutOfMemory = 4,
    Timeout = 5,
    ConcurrencyConflict = 6,
    NotInProgress = 7,
    WouldBlock = 8,
    InvalidState = 9,
    NewSocketLimit = 10,
    AddressNotBindable = 11,
    AddressInUse = 12,
    RemoteUnreachable = 13,
    ConnectionRefused = 14,
    ConnectionReset = 15,
    ConnectionAborted = 16,
    DatagramTooLarge = 17,
    NameUnresolvable = 18,
    TemporaryResolverFailure = 19,
    PermanentResolverFailure = 20,
}

Error codes.

In theory, every API can return any error code. In practice, API’s typically only return the errors documented per API combined with a couple of errors that are always possible:

• unknown
• access-denied
• not-supported
• out-of-memory
• concurrency-conflict

See each individual API for what the POSIX equivalents are. They sometimes differ per API.

Variants

Unknown = 0

Unknown error

AccessDenied = 1

Access denied.

POSIX equivalent: EACCES, EPERM

NotSupported = 2

The operation is not supported.

POSIX equivalent: EOPNOTSUPP

InvalidArgument = 3

One of the arguments is invalid.

POSIX equivalent: EINVAL

OutOfMemory = 4

Not enough memory to complete the operation.

POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY

Timeout = 5

The operation timed out before it could finish completely.

ConcurrencyConflict = 6

This operation is incompatible with another asynchronous operation that is already in progress.

POSIX equivalent: EALREADY

NotInProgress = 7

Trying to finish an asynchronous operation that:

• has not been started yet, or:
• was already finished by a previous finish-* call.

Note: this is scheduled to be removed when futures are natively supported.

WouldBlock = 8

The operation has been aborted because it could not be completed immediately.

Note: this is scheduled to be removed when futures are natively supported.

InvalidState = 9

The operation is not valid in the socket’s current state.

NewSocketLimit = 10

A new socket resource could not be created because of a system limit.

AddressNotBindable = 11

A bind operation failed because the provided address is not an address that the network can bind to.

AddressInUse = 12

A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.

RemoteUnreachable = 13

The remote address is not reachable

ConnectionRefused = 14

The TCP connection was forcefully rejected

ConnectionReset = 15

The TCP connection was reset.

ConnectionAborted = 16

A TCP connection was aborted.

DatagramTooLarge = 17

The size of a datagram sent to a UDP socket exceeded the maximum supported size.

NameUnresolvable = 18

Name does not exist or has no suitable associated IP addresses.

TemporaryResolverFailure = 19

A temporary failure in name resolution occurred.

PermanentResolverFailure = 20

A permanent failure in name resolution occurred.

Implementations

impl ErrorCode

pub fn name(&self) -> &'static str

pub fn message(&self) -> &'static str

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ErrorCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ErrorCode

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl Ord for ErrorCode

fn cmp(&self, other: &ErrorCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ErrorCode

fn eq(&self, other: &ErrorCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ErrorCode

fn partial_cmp(&self, other: &ErrorCode) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl Copy for ErrorCode

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode