Struct AtomicOption 

pub struct AtomicOption<T: Well>(/* private fields */);

Potentially empty atomic potential well.

Internally, this just wraps a pointer to <T as Deref>::Target and uses atomic pointer operations to access it. However, the number of operations on the pointer is limited to ensure correctness in safe code.

Implementations

impl<T: Well> AtomicOption<T>

pub fn none() -> AtomicOption<T>

Creates atomic without anything inside.

pub fn some(well: T) -> AtomicOption<T>

Creates atomic with something inside.

pub unsafe fn as_raw_unchecked(&self) -> &AtomicPtr<<T as Deref>::Target>

Gives access to the underlying AtomicPtr.

Safety

The pointer inside the atomic must always be null, or a valid pointer from Well::remove. Additionally, keep in mind that this atomic owns the pointer, and if you want to move it out, you must put a different pointer in its place first.

pub fn load(&self, ordering: Ordering) -> Option<&<T as Deref>::Target>

Loads the inner data as an immutable reference.

This is equivalent to an atomic load.

pub fn swap(&self, well: T, ordering: Ordering) -> Option<T>

Atomically swaps the data inside the well.

This is equivalent to an atomic swap.

pub fn take(&self, ordering: Ordering) -> Option<T>

Takes the data out of the well.

This is equivalent to an atomic swap with a null pointer.

pub fn insert( &self, well: T, success: Ordering, failure: Ordering, ) -> Result<(), T>

Inserts data into the well.

This uses compare_exchange to avoid inserting into the well if it’s already full. If you want to use compare_exchange_weak instead, use insert_weak.

pub fn insert_weak( &self, well: T, success: Ordering, failure: Ordering, ) -> Result<(), T>

Inserts data into the well, sometimes failing spuriously.

This uses compare_exchange_weak to avoid inserting into the well if it’s already full, which may spuriously fail. If you want to use compare_exchange instead, use insert.

impl<T: WellMut<Target: Unpin>> AtomicOption<T>

pub fn load_mut(&mut self) -> Option<&mut <T as Deref>::Target>

Loads the inner data as a mutable reference.

This performs a non-atomic access since the atomic is mutably borrowed.

impl<T: WellMut> AtomicOption<Pin<T>>

where Pin<T>: Well,

pub fn load_mut_pinned(&mut self) -> Option<Pin<&mut <Pin<T> as Deref>::Target>>

Loads the inner data as a pinned mutable reference.

This is a version of load_mut that works with pinned values.

impl<T: Well + Clone> AtomicOption<T>

pub fn load_clone(&self, ordering: Ordering) -> Option<T>

Loads a clone of the inner data.

This still performs an atomic load, but instead of offering a reference, the smart pointer is cloned instead.

Trait Implementations

impl<T: Well<Target: Debug>> Debug for AtomicOption<T>

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

Formats the value using the given formatter.

impl<T: Well> Default for AtomicOption<T>

By default, nothing is stored in the atomic.

fn default() -> Self

Returns the “default value” for a type.

impl<T: Well> Drop for AtomicOption<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Well> From<Option<T>> for AtomicOption<T>

fn from(well: Option<T>) -> Self

Converts to this type from the input type.

impl<T: Well> From<T> for AtomicOption<T>

fn from(well: T) -> Self

Converts to this type from the input type.