pub struct PoisonError<T> { /* private fields */ }Expand description
A type of error which can be returned whenever a lock is acquired.
Both Mutexes and RwLocks 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. For a lock in the poisoned state, unless the state is cleared manually,
all future acquisitions will return this error.
§Examples
use std::sync::{Arc, Mutex};
use std::thread;
let mutex = Arc::new(Mutex::new(1));
// poison the mutex
let c_mutex = Arc::clone(&mutex);
let _ = thread::spawn(move || {
let mut data = c_mutex.lock().unwrap();
*data = 2;
panic!();
}).join();
match mutex.lock() {
Ok(_) => unreachable!(),
Err(p_err) => {
let data = p_err.get_ref();
println!("recovered: {data}");
}
};Implementations§
Source§impl<T> PoisonError<T>
impl<T> PoisonError<T>
1.2.0 · Sourcepub fn new(data: T) -> PoisonError<T>
Available on panic=unwind only.
pub fn new(data: T) -> PoisonError<T>
panic=unwind only.Creates a PoisonError.
This is generally created by methods like Mutex::lock
or RwLock::read.
This method may panic if std was built with panic="abort".
1.2.0 · Sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Consumes this error indicating that a lock is poisoned, returning the associated data.
§Examples
use std::collections::HashSet;
use std::sync::{Arc, Mutex};
use std::thread;
let mutex = Arc::new(Mutex::new(HashSet::new()));
// poison the mutex
let c_mutex = Arc::clone(&mutex);
let _ = thread::spawn(move || {
let mut data = c_mutex.lock().unwrap();
data.insert(10);
panic!();
}).join();
let p_err = mutex.lock().unwrap_err();
let data = p_err.into_inner();
println!("recovered {} items", data.len());Trait Implementations§
1.0.0 · Source§impl<T> Debug for PoisonError<T>
impl<T> Debug for PoisonError<T>
1.0.0 · Source§impl<T> Display for PoisonError<T>
impl<T> Display for PoisonError<T>
1.0.0 · Source§impl<T> Error for PoisonError<T>
impl<T> Error for PoisonError<T>
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§impl<T> From<PoisonError<T>> for TryLockError<T>
impl<T> From<PoisonError<T>> for TryLockError<T>
Source§fn from(err: PoisonError<T>) -> TryLockError<T>
fn from(err: PoisonError<T>) -> TryLockError<T>
Converts to this type from the input type.
Auto Trait Implementations§
impl<T> Freeze for PoisonError<T>where
T: Freeze,
impl<T> RefUnwindSafe for PoisonError<T>where
T: RefUnwindSafe,
impl<T> Send for PoisonError<T>where
T: Send,
impl<T> Sync for PoisonError<T>where
T: Sync,
impl<T> Unpin for PoisonError<T>where
T: Unpin,
impl<T> UnwindSafe for PoisonError<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more