Struct PoisonError
1.0.0 · Source
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}");
}
};Source§
1.2.0 · Source Available on panic=unwind only.
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 · Source
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());1.2.0 · Source
Reaches into this error indicating that a lock is poisoned, returning a reference to the associated data.
1.2.0 · Source
Reaches into this error indicating that a lock is poisoned, returning a mutable reference to the associated data.