Struct rayon_core::latch::OnceLatch

pub(crate) struct OnceLatch {
    core_latch: CoreLatch,
}

Once latches are used to implement one-time blocking, primarily for the termination flag of the threads in the pool.

Note: like a SpinLatch, once-latches are always associated with some registry that is probing them, which must be tickled when they are set. Unlike a SpinLatch, they don’t themselves hold a reference to that registry. This is because in some cases the registry owns the once-latch, and that would create a cycle. So a OnceLatch must be given a reference to its owning registry when it is set. For this reason, it does not implement the Latch trait (but it doesn’t have to, as it is not used in those generic contexts).

Fields

core_latch: CoreLatch

Implementations

impl OnceLatch

pub(crate) fn new() -> OnceLatch

pub(crate) unsafe fn set_and_tickle_one( this: *const Self, registry: &Registry, target_worker_index: usize, )

Set the latch, then tickle the specific worker thread, which should be the one that owns this latch.

Trait Implementations

impl AsCoreLatch for OnceLatch

fn as_core_latch(&self) -> &CoreLatch

impl Debug for OnceLatch

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

Formats the value using the given formatter.