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

source ·
pub(super) struct AtomicState(AtomicUsize);
Expand description

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§

source§

impl AtomicState

source

pub(super) fn new() -> Self

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

source

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.

source

pub(super) fn increment_version_while_locked(&self)

Increment the version counter.

source

pub(super) fn set_closed(&self)

Set the closed bit in the state.

Trait Implementations§

source§

impl Debug for AtomicState

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.