Skip to main content

PoisonGuard

Struct PoisonGuard 

Source
pub struct PoisonGuard<'a, G> { /* private fields */ }
Expand description

An RAII guard for a Poisonable. When this structure is dropped (falls out of scope), the lock will be unlocked.

The data protected by the underlying lock can be accessed through this guard via its Deref and DerefMut implementations.

This method is created by calling the lock, try_lock, read, and try_read methods on Poisonable

This guard holds a ThreadKey, so it is not possible to lock anything else until this guard is dropped. The ThreadKey can be reacquired by calling Poisonable::unlock, or Poisonable::unlock_read.

Trait Implementations§

Source§

impl<Guard> AsMut<Guard> for PoisonGuard<'_, Guard>

Source§

fn as_mut(&mut self) -> &mut Guard

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl<Guard> AsRef<Guard> for PoisonGuard<'_, Guard>

Source§

fn as_ref(&self) -> &Guard

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<Guard: Debug> Debug for PoisonGuard<'_, Guard>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, Guard: Deref<Target = T>> Deref for PoisonGuard<'_, Guard>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T, Guard: DerefMut<Target = T>> DerefMut for PoisonGuard<'_, Guard>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<Guard: Display> Display for PoisonGuard<'_, Guard>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Guard: Hash> Hash for PoisonGuard<'_, Guard>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Auto Trait Implementations§

§

impl<'a, G> Freeze for PoisonGuard<'a, G>
where G: Freeze,

§

impl<'a, G> RefUnwindSafe for PoisonGuard<'a, G>
where G: RefUnwindSafe,

§

impl<'a, G> !Send for PoisonGuard<'a, G>

§

impl<'a, G> Sync for PoisonGuard<'a, G>
where G: Sync,

§

impl<'a, G> Unpin for PoisonGuard<'a, G>
where G: Unpin,

§

impl<'a, G> UnwindSafe for PoisonGuard<'a, G>
where G: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.