Struct tokio::sync::watch::state::AtomicState

pub(super) struct AtomicState(AtomicUsize);

The state stored in an atomic integer.

The Sender uses Release ordering for storing a new state and the Receivers use Acquire ordering for loading the current state. This ensures that written values are seen by the Receivers for a proper handover.

Tuple Fields

0: AtomicUsize

Implementations

impl AtomicState

pub(super) fn new() -> Self

Create a new AtomicState that is not closed and which has the version set to Version::INITIAL.

pub(super) fn load(&self) -> StateSnapshot

Load the current value of the state.

Only used by the receiver and for debugging purposes.

The receiver side (read-only) uses Acquire ordering for a proper handover of the shared value with the sender side (single writer). The state is always updated after modifying and before releasing the (exclusive) lock on the shared value.

pub(super) fn increment_version_while_locked(&self)

Increment the version counter.

pub(super) fn set_closed(&self)

Set the closed bit in the state.

Trait Implementations

impl Debug for AtomicState

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

Formats the value using the given formatter.