Struct Atomic
pub struct Atomic<T> { /* private fields */ }
dep_atomic
only.Expand description
A generic atomic wrapper type which allows an object to be safely shared between threads.
Implementations§
§impl<T> Atomic<T>
impl<T> Atomic<T>
pub const fn is_lock_free() -> bool
pub const fn is_lock_free() -> bool
Checks if Atomic
objects of this type are lock-free.
If an Atomic
is not lock-free then it may be implemented using locks
internally, which makes it unsuitable for some situations (such as
communicating with a signal handler).
§impl<T> Atomic<T>where
T: NoUninit,
impl<T> Atomic<T>where
T: NoUninit,
pub fn get_mut(&mut self) -> &mut T
pub fn get_mut(&mut self) -> &mut T
Returns a mutable reference to the underlying type.
This is safe because the mutable reference guarantees that no other threads are concurrently accessing the atomic data.
pub fn into_inner(self) -> T
pub fn into_inner(self) -> 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) -> T
pub fn load(&self, order: Ordering) -> T
Loads a value from the Atomic
.
load
takes an Ordering
argument which describes the memory ordering
of this operation.
§Panics
Panics if order
is Release
or AcqRel
.
pub fn store(&self, val: T, order: Ordering)
pub fn store(&self, val: T, order: Ordering)
Stores a value into the Atomic
.
store
takes an Ordering
argument which describes the memory ordering
of this operation.
§Panics
Panics if order
is Acquire
or AcqRel
.
pub fn swap(&self, val: T, order: Ordering) -> T
pub fn swap(&self, val: T, order: Ordering) -> T
Stores a value into the Atomic
, returning the old value.
swap
takes an Ordering
argument which describes the memory ordering
of this operation.
pub fn compare_exchange(
&self,
current: T,
new: T,
success: Ordering,
failure: Ordering,
) -> Result<T, T> ⓘ
pub fn compare_exchange( &self, current: T, new: T, success: Ordering, failure: Ordering, ) -> Result<T, T> ⓘ
Stores a value into the Atomic
if the current value is the same as the
current
value.
The return value is a result indicating whether the new value was
written and containing the previous value. On success this value is
guaranteed to be equal to new
.
compare_exchange
takes two Ordering
arguments to describe the memory
ordering of this operation. The first describes the required ordering if
the operation succeeds while the second describes the required ordering
when the operation fails. The failure ordering can’t be Release
or
AcqRel
and must be equivalent or weaker than the success ordering.
pub fn compare_exchange_weak(
&self,
current: T,
new: T,
success: Ordering,
failure: Ordering,
) -> Result<T, T> ⓘ
pub fn compare_exchange_weak( &self, current: T, new: T, success: Ordering, failure: Ordering, ) -> Result<T, T> ⓘ
Stores a value into the Atomic
if the current value is the same as the
current
value.
Unlike compare_exchange
, this function is allowed to spuriously fail
even when the comparison succeeds, which can result in more efficient
code on some platforms. The return value is a result indicating whether
the new value was written and containing the previous value.
compare_exchange
takes two Ordering
arguments to describe the memory
ordering of this operation. The first describes the required ordering if
the operation succeeds while the second describes the required ordering
when the operation fails. The failure ordering can’t be Release
or
AcqRel
and must be equivalent or weaker than the success ordering.
success ordering.
pub fn fetch_update<F>(
&self,
set_order: Ordering,
fetch_order: Ordering,
f: F,
) -> Result<T, T> ⓘ
pub fn fetch_update<F>( &self, set_order: Ordering, fetch_order: Ordering, f: F, ) -> Result<T, 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)
.
Note: This may call the function multiple times if the value has been changed from other threads in
the meantime, as long as the function returns Some(_)
, but the function will have been applied
only once to the stored value.
fetch_update
takes two Ordering
arguments to describe the memory ordering of this operation.
The first describes the required ordering for when the operation finally succeeds while the second
describes the required ordering for loads. These correspond to the success and failure orderings of
compare_exchange
respectively.
Using Acquire
as success ordering makes the store part
of this operation Relaxed
, and using Release
makes the final successful load
Relaxed
. The (failed) load ordering can only be SeqCst
, Acquire
or Relaxed
and must be equivalent to or weaker than the success ordering.
§Examples
use atomic::{Atomic, Ordering};
let x = Atomic::new(7);
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(7));
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(7));
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(8));
assert_eq!(x.load(Ordering::SeqCst), 9);
§impl Atomic<bool>
impl Atomic<bool>
pub fn fetch_and(&self, val: bool, order: Ordering) -> bool
pub fn fetch_and(&self, val: bool, order: Ordering) -> bool
Logical “and” with a boolean value.
Performs a logical “and” operation on the current value and the argument
val
, and sets the new value to the result.
Returns the previous value.
§impl Atomic<i8>
impl Atomic<i8>
pub fn fetch_add(&self, val: i8, order: Ordering) -> i8 ⓘ
pub fn fetch_add(&self, val: i8, order: Ordering) -> i8 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: i8, order: Ordering) -> i8 ⓘ
pub fn fetch_sub(&self, val: i8, order: Ordering) -> i8 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: i8, order: Ordering) -> i8 ⓘ
pub fn fetch_and(&self, val: i8, order: Ordering) -> i8 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<i16>
impl Atomic<i16>
pub fn fetch_add(&self, val: i16, order: Ordering) -> i16 ⓘ
pub fn fetch_add(&self, val: i16, order: Ordering) -> i16 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: i16, order: Ordering) -> i16 ⓘ
pub fn fetch_sub(&self, val: i16, order: Ordering) -> i16 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: i16, order: Ordering) -> i16 ⓘ
pub fn fetch_and(&self, val: i16, order: Ordering) -> i16 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<i32>
impl Atomic<i32>
pub fn fetch_add(&self, val: i32, order: Ordering) -> i32 ⓘ
pub fn fetch_add(&self, val: i32, order: Ordering) -> i32 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: i32, order: Ordering) -> i32 ⓘ
pub fn fetch_sub(&self, val: i32, order: Ordering) -> i32 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: i32, order: Ordering) -> i32 ⓘ
pub fn fetch_and(&self, val: i32, order: Ordering) -> i32 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<i64>
impl Atomic<i64>
pub fn fetch_add(&self, val: i64, order: Ordering) -> i64 ⓘ
pub fn fetch_add(&self, val: i64, order: Ordering) -> i64 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: i64, order: Ordering) -> i64 ⓘ
pub fn fetch_sub(&self, val: i64, order: Ordering) -> i64 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: i64, order: Ordering) -> i64 ⓘ
pub fn fetch_and(&self, val: i64, order: Ordering) -> i64 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<isize>
impl Atomic<isize>
pub fn fetch_add(&self, val: isize, order: Ordering) -> isize ⓘ
pub fn fetch_add(&self, val: isize, order: Ordering) -> isize ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: isize, order: Ordering) -> isize ⓘ
pub fn fetch_sub(&self, val: isize, order: Ordering) -> isize ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: isize, order: Ordering) -> isize ⓘ
pub fn fetch_and(&self, val: isize, order: Ordering) -> isize ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<i128>
impl Atomic<i128>
pub fn fetch_add(&self, val: i128, order: Ordering) -> i128 ⓘ
pub fn fetch_add(&self, val: i128, order: Ordering) -> i128 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: i128, order: Ordering) -> i128 ⓘ
pub fn fetch_sub(&self, val: i128, order: Ordering) -> i128 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: i128, order: Ordering) -> i128 ⓘ
pub fn fetch_and(&self, val: i128, order: Ordering) -> i128 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<u8>
impl Atomic<u8>
pub fn fetch_add(&self, val: u8, order: Ordering) -> u8 ⓘ
pub fn fetch_add(&self, val: u8, order: Ordering) -> u8 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: u8, order: Ordering) -> u8 ⓘ
pub fn fetch_sub(&self, val: u8, order: Ordering) -> u8 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: u8, order: Ordering) -> u8 ⓘ
pub fn fetch_and(&self, val: u8, order: Ordering) -> u8 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<u16>
impl Atomic<u16>
pub fn fetch_add(&self, val: u16, order: Ordering) -> u16 ⓘ
pub fn fetch_add(&self, val: u16, order: Ordering) -> u16 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: u16, order: Ordering) -> u16 ⓘ
pub fn fetch_sub(&self, val: u16, order: Ordering) -> u16 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: u16, order: Ordering) -> u16 ⓘ
pub fn fetch_and(&self, val: u16, order: Ordering) -> u16 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<u32>
impl Atomic<u32>
pub fn fetch_add(&self, val: u32, order: Ordering) -> u32 ⓘ
pub fn fetch_add(&self, val: u32, order: Ordering) -> u32 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: u32, order: Ordering) -> u32 ⓘ
pub fn fetch_sub(&self, val: u32, order: Ordering) -> u32 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: u32, order: Ordering) -> u32 ⓘ
pub fn fetch_and(&self, val: u32, order: Ordering) -> u32 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<u64>
impl Atomic<u64>
pub fn fetch_add(&self, val: u64, order: Ordering) -> u64 ⓘ
pub fn fetch_add(&self, val: u64, order: Ordering) -> u64 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: u64, order: Ordering) -> u64 ⓘ
pub fn fetch_sub(&self, val: u64, order: Ordering) -> u64 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: u64, order: Ordering) -> u64 ⓘ
pub fn fetch_and(&self, val: u64, order: Ordering) -> u64 ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<usize>
impl Atomic<usize>
pub fn fetch_add(&self, val: usize, order: Ordering) -> usize ⓘ
pub fn fetch_add(&self, val: usize, order: Ordering) -> usize ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: usize, order: Ordering) -> usize ⓘ
pub fn fetch_sub(&self, val: usize, order: Ordering) -> usize ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: usize, order: Ordering) -> usize ⓘ
pub fn fetch_and(&self, val: usize, order: Ordering) -> usize ⓘ
Bitwise and with the current value, returning the previous value.
§impl Atomic<u128>
impl Atomic<u128>
pub fn fetch_add(&self, val: u128, order: Ordering) -> u128 ⓘ
pub fn fetch_add(&self, val: u128, order: Ordering) -> u128 ⓘ
Add to the current value, returning the previous value.
pub fn fetch_sub(&self, val: u128, order: Ordering) -> u128 ⓘ
pub fn fetch_sub(&self, val: u128, order: Ordering) -> u128 ⓘ
Subtract from the current value, returning the previous value.
pub fn fetch_and(&self, val: u128, order: Ordering) -> u128 ⓘ
pub fn fetch_and(&self, val: u128, order: Ordering) -> u128 ⓘ
Bitwise and with the current value, returning the previous value.
Trait Implementations§
Source§impl<T: ConstDefault> ConstDefault for Atomic<T>
impl<T: ConstDefault> ConstDefault for Atomic<T>
impl<T> RefUnwindSafe for Atomic<T>where
T: RefUnwindSafe,
impl<T> Sync for Atomic<T>
Auto Trait Implementations§
impl<T> !Freeze for Atomic<T>
impl<T> Send for Atomic<T>where
T: Send,
impl<T> Unpin for Atomic<T>where
T: Unpin,
impl<T> UnwindSafe for Atomic<T>where
T: UnwindSafe,
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> ByteSized for T
impl<T> ByteSized for T
Source§const BYTE_ALIGN: usize = _
const BYTE_ALIGN: usize = _
Source§fn byte_align(&self) -> usize ⓘ
fn byte_align(&self) -> usize ⓘ
Source§fn ptr_size_ratio(&self) -> [usize; 2]
fn ptr_size_ratio(&self) -> [usize; 2]
Source§impl<T, R> Chain<R> for Twhere
T: ?Sized,
impl<T, R> Chain<R> for Twhere
T: ?Sized,
Source§impl<T> ExtAny for T
impl<T> ExtAny for T
Source§fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
Source§impl<T> ExtMem for Twhere
T: ?Sized,
impl<T> ExtMem for Twhere
T: ?Sized,
Source§const NEEDS_DROP: bool = _
const NEEDS_DROP: bool = _
Source§fn mem_align_of_val(&self) -> usize ⓘ
fn mem_align_of_val(&self) -> usize ⓘ
Source§fn mem_size_of_val(&self) -> usize ⓘ
fn mem_size_of_val(&self) -> usize ⓘ
Source§fn mem_needs_drop(&self) -> bool
fn mem_needs_drop(&self) -> bool
true
if dropping values of this type matters. Read moreSource§fn mem_forget(self)where
Self: Sized,
fn mem_forget(self)where
Self: Sized,
self
without running its destructor. Read moreSource§fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
Source§unsafe fn mem_zeroed<T>() -> T
unsafe fn mem_zeroed<T>() -> T
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§fn mem_as_bytes(&self) -> &[u8] ⓘ
fn mem_as_bytes(&self) -> &[u8] ⓘ
unsafe_slice
only.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Hook for T
impl<T> Hook for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ
§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out
indicating that a T
is niched.