Struct loom::sync::atomic::AtomicPtr

source · [−]

pub struct AtomicPtr<T>(_);

Expand description

Mock implementation of std::sync::atomic::AtomicPtr.

NOTE: Unlike std::sync::atomic::AtomicPtr, this type has a different in-memory representation than *mut T.

Implementations

source

impl<T> AtomicPtr<T>

source

pub fn new(v: *mut T) -> AtomicPtr<T>

Creates a new instance of AtomicPtr.

source

pub unsafe fn unsync_load(&self) -> *mut T

Load the value without any synchronization.

Safety

An unsynchronized atomic load technically always has undefined behavior. However, if the atomic value is not currently visible by other threads, this should always be equivalent to a non-atomic load of an un-shared *mut T value.

source

pub fn with_mut<R>(&mut self, f: impl FnOnce(&mut *mut T) -> R) -> R

Get access to a mutable reference to the inner value.

source

pub fn load(&self, order: Ordering) -> *mut T

Loads a value from the pointer.

source

pub fn store(&self, val: *mut T, order: Ordering)

Stores a value into the pointer.

source

pub fn swap(&self, val: mut T, order: Ordering) -> mut T

Stores a value into the pointer, returning the previous value.

source

pub fn compare_and_swap(
    &self,
    current: mut T,
    new: mut T,
    order: Ordering
) -> *mut T

Stores a value into the pointer if the current value is the same as the current value.

source

pub fn compare_exchange(
 &self,
 current: mut T,
 new: mut T,
 success: Ordering,
 failure: Ordering
) -> Result<mut T, mut T>

Stores a value into the pointer if the current value is the same as the current value.

source

pub fn compare_exchange_weak(
 &self,
 current: mut T,
 new: mut T,
 success: Ordering,
 failure: Ordering
) -> Result<mut T, mut T>

Stores a value into the atomic if the current value is the same as the current value.

source

pub fn fetch_update<F>(
 &self,
 set_order: Ordering,
 fetch_order: Ordering,
 f: F
) -> Result<mut T, mut T> where
 F: FnMut(mut T) -> Option<mut T>,

Fetches the value, and applies a function to it that returns an optional new value. Returns a Result of Ok(previous_value) if the function returned Some(_), else Err(previous_value).