pub struct PoisonError<T> { /* fields omitted */ }
A type of error which can be returned whenever a lock is acquired.
Both Mutex
es and RwLock
s 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>
[src]1.2.0
Creates a PoisonError
.
This is generally created by methods like Mutex::lock
or RwLock::read
.
pub fn into_inner(self) -> T
[src]1.2.0
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ⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]1.2.0
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ⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]1.2.0
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]
impl<T> Display for PoisonError<T>
[src]
impl<T> Error for PoisonError<T>
[src]
fn description(&self) -> &str
[src]
fn source(&self) -> Option<&(dyn Error + 'static)>
[src]1.30.0
fn backtrace(&self) -> Option<&Backtrace>
[src]
fn cause(&self) -> Option<&dyn Error>
[src]
impl<T> From<PoisonError<T>> for TryLockError<T>
[src]
fn from(err: PoisonError<T>) -> TryLockError<T>
[src]
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,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
© 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