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.

## Methods

### `impl<T> PoisonError<T>`
[src]

#### `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`.

#### `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.

#### `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.

#### `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.

### `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

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  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`)