Struct rayon_core::latch::CoreLatch

pub(crate) struct CoreLatch {
    state: AtomicUsize,
}

Spin latches are the simplest, most efficient kind, but they do not support a wait() operation. They just have a boolean flag that becomes true when set() is called.

Fields

state: AtomicUsize

Implementations

impl CoreLatch

fn new() -> Self

pub(crate) fn get_sleepy(&self) -> bool

Invoked by owning thread as it prepares to sleep. Returns true if the owning thread may proceed to fall asleep, false if the latch was set in the meantime.

pub(crate) fn fall_asleep(&self) -> bool

Invoked by owning thread as it falls asleep sleep. Returns true if the owning thread should block, or false if the latch was set in the meantime.

pub(crate) fn wake_up(&self)

Invoked by owning thread as it falls asleep sleep. Returns true if the owning thread should block, or false if the latch was set in the meantime.

unsafe fn set(this: *const Self) -> bool

Set the latch. If this returns true, the owning thread was sleeping and must be awoken.

This is private because, typically, setting a latch involves doing some wakeups; those are encapsulated in the surrounding latch code.

pub(crate) fn probe(&self) -> bool

Test if this latch has been set.

Trait Implementations

impl AsCoreLatch for CoreLatch

fn as_core_latch(&self) -> &CoreLatch

impl Debug for CoreLatch

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

Formats the value using the given formatter.