std::sync::PoisonError - Rust
Description: API documentation for the Rust `PoisonError` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, PoisonError

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

    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.

# 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 &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`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 &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`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> 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.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)