Enum LockError

pub enum LockError {
    UnknownError {
        message: String,
    },
    LockBusy,
    InvalidParentLock,
    InvalidParentLockType {
        required: LockType,
        actual: LockType,
    },
    InvalidUpgrade {
        original: LockType,
        requested: LockType,
    },
}

Error enum for glock crate.

Variants

UnknownError

This error indicates an unhandled error, usually an internal Mutex poison error.

Fields

message: String

The error message from the original Error.

LockBusy

This error is returned when calling any of the try_lock variants, if the target lock is busy.

InvalidParentLock

This error is returned when calling any of the lock_using_parent variants and passing an incorrect parent GLockGuard (i.e. a GLockGuard that does not belong to the parent GLock)

InvalidParentLockType

This error occurs when upgrading a GLockGuard to a type not supported by its parent GLockGuard, if auto upgrade is disabled. Currently, auto upgrade is enabled by default, so this error should never occur.

Fields

required: LockType

The required parent lock type.

actual: LockType

The actual parent lock type.

InvalidUpgrade

This error occurs when trying to upgrade a GLockGuard to a type to which it is not upgradable.

Fields

original: LockType

The original lock type.

requested: LockType

The target lock type of the upgrade.

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, f: &mut Formatter<'_>) -> Result<(), FmtError>

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.

impl PartialEq for LockError

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

impl StructuralPartialEq for LockError