Enum LockError 

#[non_exhaustive]
pub enum LockError {
    Timeout {
        path: PathBuf,
        mode: LockMode,
        waited: Duration,
    },
    Io {
        path: PathBuf,
        mode: LockMode,
        source: Error,
    },
}

A lock that was not acquired.

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.

Timeout

The deadline passed while another holder kept the lock.

The holder is not named: advisory locks record no owner, and asking the operating system who holds one is neither portable nor race-free. The path and the elapsed wait are what a reader needs to find it.

Fields

path: PathBuf

The lock file waited on.

mode: LockMode

The access that was requested.

waited: Duration

How long the caller waited before giving up.

Io

The operating system refused the lock outright.

Fields

path: PathBuf

The lock file waited on.

mode: LockMode

The access that was requested.

source: Error

The refusal.

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.