1.0.0[][src]Struct std::sync::PoisonError

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.

Examples

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);
    }
};Run

Methods

impl<T> PoisonError<T>[src]

pub fn new(guard: T) -> PoisonError<T>
1.2.0
[src]

Creates a PoisonError.

This is generally created by methods like Mutex::lock or RwLock::read.

pub fn into_inner(self) -> T
1.2.0
[src]

Consumes this error indicating that a lock is poisoned, returning the underlying guard to allow access regardless.

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 = 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());Run

Important traits for &'_ mut I
pub fn get_ref(&self) -> &T
1.2.0
[src]

Reaches into this error indicating that a lock is poisoned, returning a reference to the underlying guard to allow access regardless.

Important traits for &'_ mut I
pub fn get_mut(&mut self) -> &mut T
1.2.0
[src]

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> Error for PoisonError<T>[src]

fn cause(&self) -> Option<&dyn Error>[src]

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

fn source(&self) -> Option<&(dyn Error + 'static)>
1.30.0
[src]

The lower-level source of this error, if any. Read more

impl<T> Debug for PoisonError<T>[src]

impl<T> Display for PoisonError<T>[src]

impl<T> From<PoisonError<T>> for TryLockError<T>[src]

Auto Trait Implementations

impl<T> Send for PoisonError<T> where
    T: Send

impl<T> Sync for PoisonError<T> where
    T: Sync

Blanket Implementations

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]