Struct crossbeam_utils::atomic::seq_lock::SeqLock

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

A simple stamped lock.

Fields

state: AtomicUsize

The current state of the lock.

All bits except the least significant one hold the current stamp. When locked, the state equals 1 and doesn’t contain a valid stamp.

Implementations

impl SeqLock

pub(crate) const fn new() -> Self

pub(crate) fn optimistic_read(&self) -> Option<usize>

If not locked, returns the current stamp.

This method should be called before optimistic reads.

pub(crate) fn validate_read(&self, stamp: usize) -> bool

Returns true if the current stamp is equal to stamp.

This method should be called after optimistic reads to check whether they are valid. The argument stamp should correspond to the one returned by method optimistic_read.

pub(crate) fn write(&'static self) -> SeqLockWriteGuard

Grabs the lock for writing.