Enum LockError

pub enum LockError {
    Open(Error),
    Readonly,
    CreateDir(Error),
    Nfs,
    NotSupported,
    Lock(Error),
    TimedOut,
    Contested,
}

Errors that can occur when attempting to acquire a FileLock

Variants

Open(Error)

An I/O error occurred attempting to open the lock file

Readonly

Exclusive locks cannot be take on read-only file systems

CreateDir(Error)

Failed to create parents directories to lock file

Nfs

Locking is not supported if the lock file is on an NFS, though note this is a bit more nuanced as NFSv4 does support file locking, but is out of scope, at least for now

NotSupported

This could happen on eg. extremely old and outdated OSes or some filesystems and is only present for completeness

Lock(Error)

An I/O error occurred attempting to un/lock the file

TimedOut

The lock could not be acquired within the caller provided timeout

Contested

The lock is currently held by another

Trait Implementations

impl Debug for LockError

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

Formats the value using the given formatter.

impl Display for LockError

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

Formats the value using the given formatter.

impl Error for LockError

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.