Enum TryLockError

pub enum TryLockError<T> {
    Poisoned(PoisonError<T>),
    LockedByCurrentThread,
    WouldBlock,
}

An error that may be returned by ThreadCheckedMutex::try_lock.

Variants

Poisoned(PoisonError<T>)

Returned when a lock was acquired, but the lock was poisoned.

Read more about poison.

LockedByCurrentThread

Returned when a lock failed to be acquired because the thread attempting to acquire the lock was already holding the lock.

WouldBlock

Returned when a lock failed to be acquired because the lock was already held by a thread (other than the thread attempting to acquire the lock).

Implementations

impl<T> TryLockError<T>

pub fn ignore_poison(self) -> PoisonlessTryLockResult<T>

Silently converts any poison error into a successful result (see PoisonError::into_inner), and otherwise returns the error unchanged in an Err.

Read more about poison.

Errors

If the provided error was not caused by poison, that error is returned.

pub fn panic_if_poison(self) -> TryLockError<Infallible>

Panics if the error was caused by poison, and otherwise returns the error unchanged.

Panics

Panics if the error was caused by poison.

Read more about poison.

Trait Implementations

impl<T> Debug for TryLockError<T>

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

Formats the value using the given formatter.

impl<T> Display for TryLockError<T>

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

Formats the value using the given formatter.

impl<T> Error for TryLockError<T>

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<T> From<PoisonError<T>> for TryLockError<T>

fn from(poison: PoisonError<T>) -> Self

Converts to this type from the input type.

impl PartialEq for TryLockError<Infallible>

fn eq(&self, other: &Self) -> 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 TryLockError<Infallible>