Struct IoError

pub struct IoError(/* private fields */);

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.

Implementations

impl IoError

pub fn new<E>(kind: IoErrorKind, error: E) -> Self

where E: Into<Arc<dyn Error + Send + Sync>>,

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

pub fn last_os_error() -> Self

See io::Error::last_os_error.

pub fn from_raw_os_error(code: i32) -> Self

See io::Error::from_raw_os_error.

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

See io::Error::raw_os_error.

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

See io::Error::get_ref.

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

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

pub 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 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

👎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 source(&self) -> Option<&(dyn Error + 'static)>

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

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 From<Error> for IoError

fn from(src: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for IoError

fn from(src: IoErrorKind) -> IoError

Converts to this type from the input type.

impl From<IoError> for Error

fn from(src: IoError) -> Self

Converts to this type from the input type.