devela::_dep::_std::sync

Module poison

Source
🔬This is a nightly-only experimental API. (sync_poison_mod)
Available on crate feature std only.
Expand description

Synchronization objects that employ poisoning.

§Poisoning

All synchronization objects in this module implement a strategy called “poisoning” where if a thread panics while holding the exclusive access granted by the primitive, the state of the primitive is set to “poisoned”. This information is then propagated to all other threads to signify that the data protected by this primitive is likely tainted (some invariant is not being upheld).

The specifics of how this “poisoned” state affects other threads depend on the primitive. See [#Overview] bellow.

For the alternative implementations that do not employ poisoning, see std::sys::nonpoisoning.

§Overview

Below is a list of synchronization objects provided by this module with a high-level overview for each object and a description of how it employs “poisoning”.

  • Condvar: Condition Variable, providing the ability to block a thread while waiting for an event to occur.

    Condition variables are typically associated with a boolean predicate (a condition) and a mutex. This implementation is associated with poison::Mutex, which employs poisoning. For this reason, Condvar::wait() will return a LockResult, just like poison::Mutex::lock() does.

  • Mutex: Mutual Exclusion mechanism, which ensures that at most one thread at a time is able to access some data.

    Mutex::lock() returns a LockResult, providing a way to deal with the poisoned state. See Mutex’s documentation for more.

  • Once: A thread-safe way to run a piece of code only once. Mostly useful for implementing one-time global initialization.

    Once is poisoned if the piece of code passed to Once::call_once() or Once::call_once_force() panics. When in poisoned state, subsequent calls to Once::call_once() will panic too. Once::call_once_force() can be used to clear the poisoned state.

  • RwLock: Provides a mutual exclusion mechanism which allows multiple readers at the same time, while allowing only one writer at a time. In some cases, this can be more efficient than a mutex.

    This implementation, like Mutex, will become poisoned on a panic. Note, however, that an RwLock may only be poisoned if a panic occurs while it is locked exclusively (write mode). If a panic occurs in any reader, then the lock will not be poisoned.

Structs§

  • CondvarExperimental
    A Condition Variable
  • MappedMutexGuardExperimental
    An RAII mutex guard returned by MutexGuard::map, which can point to a subfield of the protected data. When this structure is dropped (falls out of scope), the lock will be unlocked.
  • RAII structure used to release the shared read access of a lock when dropped, which can point to a subfield of the protected data.
  • RAII structure used to release the exclusive write access of a lock when dropped, which can point to a subfield of the protected data.
  • MutexExperimental
    A mutual exclusion primitive useful for protecting shared data
  • MutexGuardExperimental
    An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
  • OnceExperimental
    A low-level synchronization primitive for one-time global execution.
  • OnceStateExperimental
    State yielded to Once::call_once_force()’s closure parameter. The state can be used to query the poison status of the Once.
  • PoisonErrorExperimental
    A type of error which can be returned whenever a lock is acquired.
  • RwLockExperimental
    A reader-writer lock
  • RwLockReadGuardExperimental
    RAII structure used to release the shared read access of a lock when dropped.
  • RwLockWriteGuardExperimental
    RAII structure used to release the exclusive write access of a lock when dropped.
  • WaitTimeoutResultExperimental
    A type indicating whether a timed wait on a condition variable returned due to a time out or not.

Enums§

Constants§

  • ONCE_INITDeprecatedExperimental
    Initialization value for static Once values.

Type Aliases§

  • LockResultExperimental
    A type alias for the result of a lock method which can be poisoned.
  • TryLockResultExperimental
    A type alias for the result of a nonblocking locking method.