std::sync::PoisonError
Struct std::sync::PoisonError
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
Creates a PoisonError
.
This is generally created by methods like Mutex::lock
or RwLock::read
.
fn into_inner(self) -> T
1.2.0
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
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
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
Formats the value using the given formatter.
impl<T> Display for PoisonError<T>
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<T> Error for PoisonError<T>
[src]
fn description(&self) -> &str
A short description of the error. Read more
fn cause(&self) -> Option<&Error>
The lower-level cause of this error, if any. Read more
© 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