Struct error_code::ErrorCode

pub struct ErrorCode<C> { /* fields omitted */ }

Describes error code in particular category.

Implementations

impl ErrorCode<PosixCategory>

pub fn last() -> Self

Retrieves last error, generated by runtime

pub const fn unimplemented() -> Self

Creates unimplemented error

pub const fn is_would_block(self) -> bool

Returns whether underlying error means to try again.

Under POSIX, it means either EWOULDBLOCK or EAGAIN, in some cases it can be the same error code.

impl ErrorCode<SystemCategory>

pub fn last() -> Self

Retrieves last error, generated by OS

pub const fn unimplemented() -> Self

Creates unimplemented error

pub const fn is_would_block(self) -> bool

Returns whether underlying error means to try again.

Under POSIX, it means either EWOULDBLOCK or EAGAIN, in some cases it can be the same error code. In case of Windows, it is also WSAEWOULDBLOCK

impl<C> ErrorCode<C>

pub const fn new(code: i32) -> Self

Creates new error code in provided category.

pub const fn raw_code(self) -> i32

Access raw integer code

pub const fn is_zero(self) -> bool

Returns whether error code is zero.

Commonly zero is indication of no error.

impl<C: Category> ErrorCode<C>

pub fn message(self) -> Str

Returns textual representation of the error code

pub fn into_another<O: Category>(self) -> ErrorCode<O> where
    C: IntoCategory<O>, 

Converts self into error code of another category.

Requires self’s category to implement IntoCategory for destination category.

Trait Implementations

impl<C> Clone for ErrorCode<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Category> Debug for ErrorCode<C>

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

Formats the value using the given formatter.

impl<C: Category> Display for ErrorCode<C>

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

Formats the value using the given formatter.

impl<C: Category> Error for ErrorCode<C>

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<Error> for ErrorCode<PosixCategory>

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for ErrorCode<SystemCategory>

fn from(err: Error) -> Self

Performs the conversion.

impl<C> From<i32> for ErrorCode<C>

fn from(code: i32) -> Self

Performs the conversion.

impl<C> Hash for ErrorCode<C>

fn hash<H: Hasher>(&self, state: &mut H)

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<C> Ord for ErrorCode<C>

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Error> for ErrorCode<PosixCategory>

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<Error> for ErrorCode<SystemCategory>

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

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

#[must_use]

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

This method tests for !=.

impl<C> PartialEq<ErrorCode<C>> for ErrorCode<C>

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

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

#[must_use]

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

This method tests for !=.

impl<C> PartialOrd<ErrorCode<C>> for ErrorCode<C>

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

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

#[must_use]

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

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

#[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.

#[must_use]

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

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

#[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.

impl<C> Copy for ErrorCode<C>

impl<C> Eq for ErrorCode<C>

impl<C> Send for ErrorCode<C>

impl<C> Sync for ErrorCode<C>

impl<C> Unpin for ErrorCode<C>