Enum simplelock::SimpleLockError

pub enum SimpleLockError {
    AlreadyLocked,
    InvalidName,
    UnableToUnlock(String),
    PermissionDenied,
    NoLockEnabled,
    UnknownError(String),
}

SimpleLock's Error type.

Variants

AlreadyLocked

The Lock was already taken by another process, we cannot lock.

This will only be returned if the LockConfig provided explicitly disables hang_lock. In other-words, if we want to fail immediately on the inability to lock.

InvalidName

The name given on Lock creation (either with default_lock or an implementation's constructor) is invalid.

This can be due to OS path name restrictions or being invalid unicode, etc.

UnableToUnlock(String)

We failed to unlock the Lock.

This can be due to a number of issues. Using FileLock as an example, if the temporary file disappears due to an unreliable OS File-Cleaner, its permissions change out-from-under-us, etc.

PermissionDenied

The File Descriptor was created with permissions you do not currently have.

This may happen if the program was executed as a super-user and failed to clean up open files. If not using the provided utility functionality, please revisit them to see if any fit your needs. They may handle an edge-case your application hits.

NoLockEnabled

Thrown when calling default_lock and no feature flag was enabled.

UnknownError(String)

An unexpected error from one of the Lock implementations. If this happens, please file a ticket with us as we would like to harden this library over time.

Trait Implementations

impl Debug for SimpleLockError

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

Formats the value using the given formatter.

impl Display for SimpleLockError

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

Formats the value using the given formatter.

impl Eq for SimpleLockError

impl Error for SimpleLockError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Errno> for SimpleLockError

fn from(e: Errno) -> Self

Performs the conversion.

impl From<Error> for SimpleLockError

fn from(other: Error) -> Self

Performs the conversion.

impl From<Error> for SimpleLockError

fn from(e: Error) -> Self

Performs the conversion.

impl From<ErrorKind> for SimpleLockError

fn from(other: ErrorKind) -> Self

Performs the conversion.

impl Ord for SimpleLockError

fn cmp(&self, other: &SimpleLockError) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SimpleLockError> for SimpleLockError

fn eq(&self, other: &SimpleLockError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SimpleLockError) -> bool

This method tests for !=.

impl PartialOrd<SimpleLockError> for SimpleLockError

fn partial_cmp(&self, other: &SimpleLockError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SimpleLockError) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SimpleLockError) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SimpleLockError) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SimpleLockError) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for SimpleLockError

impl StructuralPartialEq for SimpleLockError