Struct cancel_safe_futures::sync::PoisonError

pub struct PoisonError<T> { /* private fields */ }

Available on crate feature std only.

A type of error which can be returned whenever a RobustMutex is acquired.

RobustMutexes are poisoned whenever a thread panics or a cancellation happens while the lock is held. The precise semantics for when a lock is poisoned is documented on RobustMutex, but once a lock is poisoned then all future acquisitions will return this error.

Implementations

impl<T> PoisonError<T>

pub fn is_panic(&self) -> bool

Returns true if this error indicates that the lock was poisoned by a panic from another task.

pub fn is_cancel(&self) -> bool

Returns true if this error indicates that the lock was poisoned by an early cancellation.

pub fn into_inner(self) -> T

Consumes this error indicating that a lock is poisoned, returning the underlying guard to allow access regardless.

pub fn get_ref(&self) -> &T

Reaches into this error indicating that a lock is poisoned, returning a reference to the underlying guard to allow access regardless.

pub fn get_mut(&mut self) -> &mut T

Reaches into this error indicating that a lock is poisoned, returning a mutable reference to the underlying guard to allow access regardless.

Trait Implementations

impl<T> Debug for PoisonError<T>

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

Formats the value using the given formatter.

impl<T> Display for PoisonError<T>

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

Formats the value using the given formatter.

impl<T> Error for PoisonError<T>

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

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(error: PoisonError<T>) -> TryLockError<T>

Converts to this type from the input type.