Struct AtomicFallbackPtr

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

Available on doc only.

An example fallback implementation of an atomic pointer.

AtomicPtr points to a type like this when no built-in atomic pointer is available.

This type is the pointer version of AtomicFallback; see its documentation for more details. Like AtomicFallback, this type is exposed only in the documentation for illustrative purposes.

Implementations

impl<T> AtomicFallbackPtr<T>

pub const fn new(v: *mut T) -> Self

Creates a new atomic.

See atomic::AtomicPtr::new.

pub fn get_mut(&mut self) -> &mut *mut T

Returns a mutable reference to the underlying value.

See atomic::AtomicPtr::get_mut.

pub fn into_inner(self) -> *mut T

Consumes the atomic and returns the contained value.

See atomic::AtomicPtr::into_inner.

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

Loads a value from the atomic.

See atomic::AtomicPtr::load.

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

Stores a value into the atomic.

See atomic::AtomicPtr::store.

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

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

See atomic::AtomicPtr::swap.

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

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

See atomic::AtomicPtr::compare_and_swap.

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 atomic if the current value is the same as the current value.

See atomic::AtomicPtr::compare_exchange.

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.

See atomic::AtomicPtr::compare_exchange_weak.

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.

See atomic::AtomicPtr::fetch_update.

pub const fn as_ptr(&self) -> *mut *mut T

Returns a mutable pointer to the underlying value.

See atomic::AtomicPtr::as_ptr.

Trait Implementations

impl<T> Sync for AtomicFallbackPtr<T>