Struct arc_io_error::IoError

pub struct IoError(_);

A version of std::io::Error implemented on top of Arc instead of Box, making it cloneable.

The API of this type has been designed to match io::Error, with two exceptions:

• IoError::new and IoError::into_inner substitute Arc for Box, and
• IoError has no equivalent to io::Error::get_mut, as the inner error instance is shared.

See the standard library documentation for more detailed API-level descriptions than are given here.

IoError implements From for io::Error and vice-versa, so the two types can easily be converted between each other. A type containing io::Error can be made Clone-compatible by instead storing IoError internally and converting from/to io::Error on API boundaries.

Clones derived from the same original IoError instance will share a single heap-allocated error instance (if one is present) using Arc. io::Error instances produced by converting those clones back with the From implementation will also share the same single error instance.

Methods

impl IoError

fn new<E>(kind: IoErrorKind, error: E) -> Self where
    E: Into<Arc<Error + Send + Sync>>, 

See io::Error::new, with Arc substituted for Box.

fn last_os_error() -> Self

See io::Error::last_os_error.

fn from_raw_os_error(code: i32) -> Self

See io::Error::from_raw_os_error.

fn raw_os_error(&self) -> Option<i32>

See io::Error::raw_os_error.

fn get_ref(&self) -> Option<&(Error + Send + Sync + 'static)>

See io::Error::get_ref.

fn into_inner(self) -> Option<Arc<Error + Send + Sync>>

See io::Error::into_inner, with Arc substituted for Box.

fn kind(&self) -> IoErrorKind

See io::Error::kind.

Trait Implementations

impl Clone for IoError

fn clone(&self) -> IoError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Error> for IoError

fn from(src: Error) -> Self

Performs the conversion.

impl From<IoErrorKind> for IoError

fn from(src: IoErrorKind) -> IoError

Performs the conversion.

impl Debug for IoError

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for IoError

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Error for IoError

fn description(&self) -> &str

A short description of the error.

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

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