pub struct PoisonError<T> { /* fields omitted */ }
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, but once a lock is poisoned then all future acquisitions will return this error.
use std::sync::{Arc, Mutex};
use std::thread;
let mutex = Arc::new(Mutex::new(1));
// poison the mutex
let c_mutex = mutex.clone();
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);
}
}; impl<T> PoisonError<T>
[src]
pub fn new(guard: T) -> PoisonError<T>
Creates a PoisonError.
This is generally created by methods like Mutex::lock or RwLock::read.
pub fn into_inner(self) -> T
Consumes this error indicating that a lock is poisoned, returning the underlying guard to allow access regardless.
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 = mutex.clone();
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()); 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.
impl<T> Debug for PoisonError<T>
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<T> Display for PoisonError<T>
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<T> Error for PoisonError<T>
[src]
fn description(&self) -> &str
[src]
A short description of the error. Read more
fn cause(&self) -> Option<&Error>
[src]
The lower-level cause of this error, if any. Read more
impl<T> From<PoisonError<T>> for TryLockError<T>
[src]
fn from(err: PoisonError<T>) -> TryLockError<T>
[src]
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/sync/struct.PoisonError.html