Enum ErrorKind

pub enum ErrorKind {
    Std(ErrorKind, Sealed),
    NotAFile,
    AlreadyInUse,
    FileNotFound,
    DirectoryNotFound,
}

Variants

Std(ErrorKind, Sealed)

std::io::ErrorKind from the standard library.

This variant wraps a standard library error kind and extends our own error enum with it. The hidden field prevents other crates, even our own, from constructing this directly. Most of the time, you already have a full std::io::Error, so just pass that directly to IoError::new or IoError::new_with_additional_context. This allows us to inspect the raw os error of std::io::Errors.

Matching is still easy:

match err_kind {
    ErrorKind::Std(std::io::ErrorKind::NotFound, ..) => { /* ... */ }
    _ => {}
}

If you want to provide an std::io::ErrorKind manually, use ErrorKind::from_std.

NotAFile

AlreadyInUse

The file or directory is in use by another program.

On Windows, this maps to ERROR_SHARING_VIOLATION and prevents access like deletion or modification.

FileNotFound

DirectoryNotFound

Implementations

impl ErrorKind

pub fn from_std(kind: ErrorKind) -> Self

Construct an ErrorKind from a std::io::ErrorKind without a full std::io::Error.

In most cases, you should use IoError::new and pass the full std::io::Error instead. This method is only meant for cases where we provide our own io error kinds.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Diagnostic for ErrorKind

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for ErrorKind

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

Formats the value using the given formatter.

impl Error for ErrorKind

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 From<&Error> for ErrorKind

fn from(err: &Error) -> Self

Converts to this type from the input type.

impl From<Error> for ErrorKind

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for ErrorKind

fn from(value: ErrorKind) -> Self

Converts to this type from the input type.

impl IoErrorExt for ErrorKind

fn not_found_as(self, kind: NotFound) -> ErrorKind

Map NotFound variants into more precise variants.

impl PartialEq for ErrorKind

fn eq(&self, other: &ErrorKind) -> 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 Copy for ErrorKind

impl Eq for ErrorKind

impl StructuralPartialEq for ErrorKind