Struct AtomicTake

pub struct AtomicTake<T> { /* private fields */ }

A container with an atomic take operation.

Implementations

impl<T> AtomicTake<T>

pub const fn new(value: T) -> Self

Create a new AtomicTake with the given value.

pub const fn empty() -> Self

Create an empty AtomicTake that contains no value.

pub fn take(&self) -> Option<T>

Takes out the value from this AtomicTake. It is guaranteed that exactly one caller will receive the value and all others will receive None.

pub fn take_mut(&mut self) -> Option<T>

This methods does the same as take, but does not use an atomic swap.

This is safe because you cannot call this method without unique access to the AtomicTake, so no other threads will try to take it concurrently.

pub fn is_taken(&self) -> bool

Check whether the value is taken. Note that if this returns false, then this is immediately stale if another thread could be concurrently trying to take it.

pub fn insert(&mut self, value: T) -> Option<T>

Insert a new value into the AtomicTake and return the previous value.

This function requires unique access to ensure no other threads accesses the AtomicTake concurrently, as this operation cannot be performed atomically without a lock.

Trait Implementations

impl<T> Debug for AtomicTake<T>

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

Formats the value using the given formatter.

impl<T> Drop for AtomicTake<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for AtomicTake<T>

fn from(t: T) -> AtomicTake<T>

Converts to this type from the input type.

impl<T: Send> Sync for AtomicTake<T>