Struct sgx_tstd::sync::PoisonError

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

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

Both SgxMutexes and SgxRwLocks are poisoned whenever a thread fails while the lock is held. The precise semantics for when a lock is poisoned is documented on each lock, but once a lock is poisoned then all future acquisitions will return this error.

Methods

impl<T> PoisonError<T>

pub fn new(guard: T) -> PoisonError<T>

Creates a PoisonError.

This is generally created by methods like [SgxMutex::lock] or [SgxRwLock::read].

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 description(&self) -> &str

A short description of the error.

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

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

fn type_id(&self) -> TypeId where     Self: 'static,

Get the TypeId of self

impl<T> From<PoisonError<T>> for TryLockError<T>

fn from(err: PoisonError<T>) -> TryLockError<T>

Performs the conversion.