Module rustc_data_structures::sync

This module defines types which are thread safe if cfg!(parallel_compiler) is true.

Lrc is an alias of Arc if cfg!(parallel_compiler) is true, Rc otherwise.

Lock is a mutex. It internally uses parking_lot::Mutex if cfg!(parallel_compiler) is true, RefCell otherwise.

RwLock is a read-write lock. It internally uses parking_lot::RwLock if cfg!(parallel_compiler) is true, RefCell otherwise.

MTLock is a mutex which disappears if cfg!(parallel_compiler) is false.

MTRef is an immutable reference if cfg!(parallel_compiler), and a mutable reference otherwise.

rustc_erase_owner! erases an OwningRef owner into Erased or Erased + Send + Sync depending on the value of cfg!(parallel_compiler).

Re-exports

• pub use std::sync::atomic::Ordering::SeqCst;

Structs

• AtomicBool
  A boolean type which can be safely shared between threads.
• AtomicU32
  An integer type which can be safely shared between threads.
• AtomicU64
  An integer type which can be safely shared between threads.
• AtomicUsize
  An integer type which can be safely shared between threads.
• Lrc
  A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
• Weak
  Weak is a version of Arc that holds a non-owning reference to the managed allocation. The allocation is accessed by calling upgrade on the Weak pointer, which returns an Option<Arc<T>>.
• WorkerLocal
  Holds worker-locals values for each thread in a thread pool. You can only access the worker local value through the Deref impl on the thread pool it was constructed on. It will panic otherwise

Enums

• Ordering
  Atomic memory orderings

Traits

• HashMapExt
• ParallelIterator
  Parallel version of the standard iterator trait.
• Send
  Types that can be transferred across thread boundaries.
• Sync
  Types for which it is safe to share references between threads.

Functions

• assert_send
• assert_send_sync_val
• assert_send_val
• assert_sync
• join
  Takes two closures and potentially runs them in parallel. It returns a pair of the results from those closures.
• par_for_each_in
• par_iter
• scope
  Create a “fork-join” scope s and invokes the closure with a reference to s. This closure can then spawn asynchronous tasks into s. Those tasks may run asynchronously with respect to the closure; they may themselves spawn additional tasks into s. When the closure returns, it will block until all tasks that have been spawned into s complete.

Type Aliases

• LockGuard
  An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
• MTRef
• MappedLockGuard
  An RAII mutex guard returned by MutexGuard::map, which can point to a subfield of the protected data.
• MappedReadGuard
  An RAII read lock guard returned by RwLockReadGuard::map, which can point to a subfield of the protected data.
• MappedWriteGuard
  An RAII write lock guard returned by RwLockWriteGuard::map, which can point to a subfield of the protected data.
• ReadGuard
  RAII structure used to release the shared read access of a lock when dropped.
• WriteGuard
  RAII structure used to release the exclusive write access of a lock when dropped.