Struct std::sync::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, 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 = 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}");
 }
};

Run

Implementations

source

impl<T> PoisonError<T>

1.2.0 · source

pub fn new(guard: T) -> PoisonError<T>

Creates a PoisonError.

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

1.2.0 · source

pub fn into_inner(self) -> T

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

Run

1.2.0 · source

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.

1.2.0 · source

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.

Trait Implementations

source

impl<T> Debug for PoisonError<T>

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<T> Display for PoisonError<T>

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<T> Error for PoisonError<T>

source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

Read more

1.30.0 · source

fn source(&self) -> Option<&(dyn Error + 'static)>

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

source

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

source

fn provide<'a>(&'a self, req: &mut Demand<'a>)

🔬 This is a nightly-only experimental API. (error_generic_member_access #99301)

Provides type based access to context intended for error reports. Read more

source

impl<T> From<PoisonError<T>> for TryLockError<T>

source

fn from(err: PoisonError<T>) -> TryLockError<T>

Converts to this type from the input type.