Struct atomic_maybe_uninit::AtomicMaybeUninit

#[repr(C)]
pub struct AtomicMaybeUninit<T: Primitive> { /* private fields */ }

A potentially uninitialized integer type which can be safely shared between threads.

This type has the same in-memory representation as the underlying integer type, T.

Implementations

impl<T: Primitive> AtomicMaybeUninit<T>

pub const fn new(v: MaybeUninit<T>) -> Self

Creates a new atomic integer.

This is const fn on Rust 1.61+. See also const_new function.

pub fn get_mut(&mut self) -> &mut MaybeUninit<T>

Returns a mutable reference to the underlying integer.

This is safe because the mutable reference guarantees that no other threads are concurrently accessing the atomic data.

pub fn into_inner(self) -> MaybeUninit<T>

Consumes the atomic and returns the contained value.

This is safe because passing self by value guarantees that no other threads are concurrently accessing the atomic data.

pub fn load(&self, order: Ordering) -> MaybeUninit<T> where
    T: AtomicLoad, 

Loads a value from the atomic integer.

load takes an Ordering argument which describes the memory ordering of this operation. Possible values are SeqCst, Acquire and Relaxed.

Panics

Panics if order is Release or AcqRel.

pub fn store(&self, val: MaybeUninit<T>, order: Ordering) where
    T: AtomicStore, 

Stores a value into the atomic integer.

store takes an Ordering argument which describes the memory ordering of this operation. Possible values are SeqCst, Release and Relaxed.

Panics

Panics if order is Acquire or AcqRel.

pub fn swap(&self, val: MaybeUninit<T>, order: Ordering) -> MaybeUninit<T> where
    T: AtomicSwap, 

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

swap takes an Ordering argument which describes the memory ordering of this operation. All ordering modes are possible. Note that using Acquire makes the store part of this operation Relaxed, and using Release makes the load part Relaxed.

impl AtomicMaybeUninit<i8>

pub const fn const_new(v: MaybeUninit<i8>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<u8>

pub const fn const_new(v: MaybeUninit<u8>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<i16>

pub const fn const_new(v: MaybeUninit<i16>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<u16>

pub const fn const_new(v: MaybeUninit<u16>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<i32>

pub const fn const_new(v: MaybeUninit<i32>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<u32>

pub const fn const_new(v: MaybeUninit<u32>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<i64>

pub const fn const_new(v: MaybeUninit<i64>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<u64>

pub const fn const_new(v: MaybeUninit<u64>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<i128>

pub const fn const_new(v: MaybeUninit<i128>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<u128>

pub const fn const_new(v: MaybeUninit<u128>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<isize>

pub const fn const_new(v: MaybeUninit<isize>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

impl AtomicMaybeUninit<usize>

pub const fn const_new(v: MaybeUninit<usize>) -> Self

Creates a new atomic integer. Unlike new, this is always const fn.

Trait Implementations

impl<T: Primitive> Debug for AtomicMaybeUninit<T>

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

Formats the value using the given formatter.

impl<T: Primitive> From<MaybeUninit<T>> for AtomicMaybeUninit<T>

fn from(v: MaybeUninit<T>) -> Self

Performs the conversion.

impl<T: Primitive> From<T> for AtomicMaybeUninit<T>

fn from(v: T) -> Self

Performs the conversion.

impl<T: Primitive> RefUnwindSafe for AtomicMaybeUninit<T>

impl<T: Primitive> Sync for AtomicMaybeUninit<T>