Enum Error

#[non_exhaustive]
pub enum Error {
    Io(Error),
    LockTaken,
}

A wrapper around io::Error to distinguish between the lock already existing and other errors.

Without this, it would not be possible to tell if the io::ErrorKind::AlreadyExists came from the lockfile or from the parent directory (if it already exists and is a file).

The error is non-exhaustive, in case we want to give more granular errors in future.

Examples

use lockfile::Error;
// `err` is the value returned by Lockfile::open
match err {
    Error::LockTaken => println!("lock exists, maybe we block in some way"),
    // Use err.into_inner to handle non exhaustiveness
    err => panic!("unrecoverable error: {}", err.into_inner()),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Io(Error)

LockTaken

Implementations

impl Error

pub fn into_inner(self) -> Error

Get at the underlying io::Error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.