Module sync

Modules

• atomic
  Atomic types
• mpsc
  Multi-producer, single-consumer FIFO queue communication primitives.
• mpmcExperimental
  Multi-producer, multi-consumer FIFO queue communication primitives.

Structs

• Arc
  A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
• Barrier
  A barrier enables multiple threads to synchronize the beginning of some computation.
• BarrierWaitResult
  A BarrierWaitResult is returned by Barrier::wait() when all threads in the Barrier have rendezvoused.
• Condvar
  A Condition Variable
• LazyLock
  A value which is initialized on the first access.
• Mutex
  A mutual exclusion primitive useful for protecting shared data
• MutexGuard
  An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
• Once
  A low-level synchronization primitive for one-time global execution.
• OnceLock
  A synchronization primitive which can nominally be written to only once.
• OnceState
  State yielded to Once::call_once_force()’s closure parameter. The state can be used to query the poison status of the Once.
• PoisonError
  A type of error which can be returned whenever a lock is acquired.
• RwLock
  A reader-writer lock
• RwLockReadGuard
  RAII structure used to release the shared read access of a lock when dropped.
• RwLockWriteGuard
  RAII structure used to release the exclusive write access of a lock when dropped.
• WaitTimeoutResult
  A type indicating whether a timed wait on a condition variable returned due to a time out or not.
• Weak
  Weak is a version of Arc that holds a non-owning reference to the managed allocation.
• ExclusiveExperimental
  Exclusive provides only mutable access, also referred to as exclusive access to the underlying value. It provides no immutable, or shared access to the underlying value.
• 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.
• MappedRwLockReadGuardExperimental
  RAII structure used to release the shared read access of a lock when dropped, which can point to a subfield of the protected data.
• MappedRwLockWriteGuardExperimental
  RAII structure used to release the exclusive write access of a lock when dropped, which can point to a subfield of the protected data.
• ReentrantLockExperimental
  A re-entrant mutual exclusion lock
• ReentrantLockGuardExperimental
  An RAII implementation of a “scoped lock” of a re-entrant lock. When this structure is dropped (falls out of scope), the lock will be unlocked.

Enums

• TryLockError
  An enumeration of possible errors associated with a TryLockResult which can occur while trying to acquire a lock, from the try_lock method on a Mutex or the try_read and try_write methods on an RwLock.

Constants

• ONCE_INITDeprecated
  Initialization value for static Once values.

Type Aliases

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