Struct atomic::Atomic [−][src]
pub struct Atomic<T: Copy> { /* fields omitted */ }
A generic atomic wrapper type which allows an object to be safely shared between threads.
Methods
impl<T: Copy> Atomic<T>
[src]
impl<T: Copy> Atomic<T>
pub fn new(v: T) -> Atomic<T>
[src]
pub fn new(v: T) -> Atomic<T>
Creates a new Atomic
.
pub fn is_lock_free() -> bool
[src]
pub 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).
pub fn load(&self, order: Ordering) -> T
[src]
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)
[src]
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
[src]
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>
[src]
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 Acquire
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>
[src]
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 Acquire
or
AcqRel
and must be equivalent or weaker than the success ordering.
success ordering.
impl Atomic<bool>
[src]
impl Atomic<bool>
pub fn fetch_and(&self, val: bool, order: Ordering) -> bool
[src]
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.
pub fn fetch_or(&self, val: bool, order: Ordering) -> bool
[src]
pub fn fetch_or(&self, val: bool, order: Ordering) -> bool
Logical "or" with a boolean value.
Performs a logical "or" operation on the current value and the argument
val
, and sets the new value to the result.
Returns the previous value.
pub fn fetch_xor(&self, val: bool, order: Ordering) -> bool
[src]
pub fn fetch_xor(&self, val: bool, order: Ordering) -> bool
Logical "xor" with a boolean value.
Performs a logical "xor" operation on the current value and the argument
val
, and sets the new value to the result.
Returns the previous value.
impl Atomic<i8>
[src]
impl Atomic<i8>
pub fn fetch_add(&self, val: i8, order: Ordering) -> i8
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: i8, order: Ordering) -> i8
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: i8, order: Ordering) -> i8
[src]
pub fn fetch_or(&self, val: i8, order: Ordering) -> i8
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: i8, order: Ordering) -> i8
[src]
pub fn fetch_xor(&self, val: i8, order: Ordering) -> i8
Bitwise xor with the current value, returning the previous value.
impl Atomic<i16>
[src]
impl Atomic<i16>
pub fn fetch_add(&self, val: i16, order: Ordering) -> i16
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: i16, order: Ordering) -> i16
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: i16, order: Ordering) -> i16
[src]
pub fn fetch_or(&self, val: i16, order: Ordering) -> i16
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: i16, order: Ordering) -> i16
[src]
pub fn fetch_xor(&self, val: i16, order: Ordering) -> i16
Bitwise xor with the current value, returning the previous value.
impl Atomic<i32>
[src]
impl Atomic<i32>
pub fn fetch_add(&self, val: i32, order: Ordering) -> i32
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: i32, order: Ordering) -> i32
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: i32, order: Ordering) -> i32
[src]
pub fn fetch_or(&self, val: i32, order: Ordering) -> i32
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: i32, order: Ordering) -> i32
[src]
pub fn fetch_xor(&self, val: i32, order: Ordering) -> i32
Bitwise xor with the current value, returning the previous value.
impl Atomic<i64>
[src]
impl Atomic<i64>
pub fn fetch_add(&self, val: i64, order: Ordering) -> i64
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: i64, order: Ordering) -> i64
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: i64, order: Ordering) -> i64
[src]
pub fn fetch_or(&self, val: i64, order: Ordering) -> i64
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: i64, order: Ordering) -> i64
[src]
pub fn fetch_xor(&self, val: i64, order: Ordering) -> i64
Bitwise xor with the current value, returning the previous value.
impl Atomic<isize>
[src]
impl Atomic<isize>
pub fn fetch_add(&self, val: isize, order: Ordering) -> isize
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: isize, order: Ordering) -> isize
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: isize, order: Ordering) -> isize
[src]
pub fn fetch_or(&self, val: isize, order: Ordering) -> isize
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: isize, order: Ordering) -> isize
[src]
pub fn fetch_xor(&self, val: isize, order: Ordering) -> isize
Bitwise xor with the current value, returning the previous value.
impl Atomic<i128>
[src]
impl Atomic<i128>
pub fn fetch_add(&self, val: i128, order: Ordering) -> i128
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: i128, order: Ordering) -> i128
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: i128, order: Ordering) -> i128
[src]
pub fn fetch_or(&self, val: i128, order: Ordering) -> i128
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: i128, order: Ordering) -> i128
[src]
pub fn fetch_xor(&self, val: i128, order: Ordering) -> i128
Bitwise xor with the current value, returning the previous value.
impl Atomic<i8>
[src]
impl Atomic<i8>
pub fn fetch_min(&self, val: i8, order: Ordering) -> i8
[src]
pub fn fetch_min(&self, val: i8, order: Ordering) -> i8
Minimum with the current value.
pub fn fetch_max(&self, val: i8, order: Ordering) -> i8
[src]
pub fn fetch_max(&self, val: i8, order: Ordering) -> i8
Maximum with the current value.
impl Atomic<i16>
[src]
impl Atomic<i16>
pub fn fetch_min(&self, val: i16, order: Ordering) -> i16
[src]
pub fn fetch_min(&self, val: i16, order: Ordering) -> i16
Minimum with the current value.
pub fn fetch_max(&self, val: i16, order: Ordering) -> i16
[src]
pub fn fetch_max(&self, val: i16, order: Ordering) -> i16
Maximum with the current value.
impl Atomic<i32>
[src]
impl Atomic<i32>
pub fn fetch_min(&self, val: i32, order: Ordering) -> i32
[src]
pub fn fetch_min(&self, val: i32, order: Ordering) -> i32
Minimum with the current value.
pub fn fetch_max(&self, val: i32, order: Ordering) -> i32
[src]
pub fn fetch_max(&self, val: i32, order: Ordering) -> i32
Maximum with the current value.
impl Atomic<i64>
[src]
impl Atomic<i64>
pub fn fetch_min(&self, val: i64, order: Ordering) -> i64
[src]
pub fn fetch_min(&self, val: i64, order: Ordering) -> i64
Minimum with the current value.
pub fn fetch_max(&self, val: i64, order: Ordering) -> i64
[src]
pub fn fetch_max(&self, val: i64, order: Ordering) -> i64
Maximum with the current value.
impl Atomic<isize>
[src]
impl Atomic<isize>
pub fn fetch_min(&self, val: isize, order: Ordering) -> isize
[src]
pub fn fetch_min(&self, val: isize, order: Ordering) -> isize
Minimum with the current value.
pub fn fetch_max(&self, val: isize, order: Ordering) -> isize
[src]
pub fn fetch_max(&self, val: isize, order: Ordering) -> isize
Maximum with the current value.
impl Atomic<i128>
[src]
impl Atomic<i128>
pub fn fetch_min(&self, val: i128, order: Ordering) -> i128
[src]
pub fn fetch_min(&self, val: i128, order: Ordering) -> i128
Minimum with the current value.
pub fn fetch_max(&self, val: i128, order: Ordering) -> i128
[src]
pub fn fetch_max(&self, val: i128, order: Ordering) -> i128
Maximum with the current value.
impl Atomic<u8>
[src]
impl Atomic<u8>
pub fn fetch_add(&self, val: u8, order: Ordering) -> u8
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: u8, order: Ordering) -> u8
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: u8, order: Ordering) -> u8
[src]
pub fn fetch_or(&self, val: u8, order: Ordering) -> u8
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: u8, order: Ordering) -> u8
[src]
pub fn fetch_xor(&self, val: u8, order: Ordering) -> u8
Bitwise xor with the current value, returning the previous value.
impl Atomic<u16>
[src]
impl Atomic<u16>
pub fn fetch_add(&self, val: u16, order: Ordering) -> u16
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: u16, order: Ordering) -> u16
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: u16, order: Ordering) -> u16
[src]
pub fn fetch_or(&self, val: u16, order: Ordering) -> u16
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: u16, order: Ordering) -> u16
[src]
pub fn fetch_xor(&self, val: u16, order: Ordering) -> u16
Bitwise xor with the current value, returning the previous value.
impl Atomic<u32>
[src]
impl Atomic<u32>
pub fn fetch_add(&self, val: u32, order: Ordering) -> u32
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: u32, order: Ordering) -> u32
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: u32, order: Ordering) -> u32
[src]
pub fn fetch_or(&self, val: u32, order: Ordering) -> u32
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: u32, order: Ordering) -> u32
[src]
pub fn fetch_xor(&self, val: u32, order: Ordering) -> u32
Bitwise xor with the current value, returning the previous value.
impl Atomic<u64>
[src]
impl Atomic<u64>
pub fn fetch_add(&self, val: u64, order: Ordering) -> u64
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: u64, order: Ordering) -> u64
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: u64, order: Ordering) -> u64
[src]
pub fn fetch_or(&self, val: u64, order: Ordering) -> u64
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: u64, order: Ordering) -> u64
[src]
pub fn fetch_xor(&self, val: u64, order: Ordering) -> u64
Bitwise xor with the current value, returning the previous value.
impl Atomic<usize>
[src]
impl Atomic<usize>
pub fn fetch_add(&self, val: usize, order: Ordering) -> usize
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: usize, order: Ordering) -> usize
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: usize, order: Ordering) -> usize
[src]
pub fn fetch_or(&self, val: usize, order: Ordering) -> usize
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: usize, order: Ordering) -> usize
[src]
pub fn fetch_xor(&self, val: usize, order: Ordering) -> usize
Bitwise xor with the current value, returning the previous value.
impl Atomic<u128>
[src]
impl Atomic<u128>
pub fn fetch_add(&self, val: u128, order: Ordering) -> u128
[src]
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
[src]
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
[src]
pub fn fetch_and(&self, val: u128, order: Ordering) -> u128
Bitwise and with the current value, returning the previous value.
pub fn fetch_or(&self, val: u128, order: Ordering) -> u128
[src]
pub fn fetch_or(&self, val: u128, order: Ordering) -> u128
Bitwise or with the current value, returning the previous value.
pub fn fetch_xor(&self, val: u128, order: Ordering) -> u128
[src]
pub fn fetch_xor(&self, val: u128, order: Ordering) -> u128
Bitwise xor with the current value, returning the previous value.
impl Atomic<u8>
[src]
impl Atomic<u8>
pub fn fetch_min(&self, val: u8, order: Ordering) -> u8
[src]
pub fn fetch_min(&self, val: u8, order: Ordering) -> u8
Minimum with the current value.
pub fn fetch_max(&self, val: u8, order: Ordering) -> u8
[src]
pub fn fetch_max(&self, val: u8, order: Ordering) -> u8
Maximum with the current value.
impl Atomic<u16>
[src]
impl Atomic<u16>
pub fn fetch_min(&self, val: u16, order: Ordering) -> u16
[src]
pub fn fetch_min(&self, val: u16, order: Ordering) -> u16
Minimum with the current value.
pub fn fetch_max(&self, val: u16, order: Ordering) -> u16
[src]
pub fn fetch_max(&self, val: u16, order: Ordering) -> u16
Maximum with the current value.
impl Atomic<u32>
[src]
impl Atomic<u32>
pub fn fetch_min(&self, val: u32, order: Ordering) -> u32
[src]
pub fn fetch_min(&self, val: u32, order: Ordering) -> u32
Minimum with the current value.
pub fn fetch_max(&self, val: u32, order: Ordering) -> u32
[src]
pub fn fetch_max(&self, val: u32, order: Ordering) -> u32
Maximum with the current value.
impl Atomic<u64>
[src]
impl Atomic<u64>
pub fn fetch_min(&self, val: u64, order: Ordering) -> u64
[src]
pub fn fetch_min(&self, val: u64, order: Ordering) -> u64
Minimum with the current value.
pub fn fetch_max(&self, val: u64, order: Ordering) -> u64
[src]
pub fn fetch_max(&self, val: u64, order: Ordering) -> u64
Maximum with the current value.
impl Atomic<usize>
[src]
impl Atomic<usize>
pub fn fetch_min(&self, val: usize, order: Ordering) -> usize
[src]
pub fn fetch_min(&self, val: usize, order: Ordering) -> usize
Minimum with the current value.
pub fn fetch_max(&self, val: usize, order: Ordering) -> usize
[src]
pub fn fetch_max(&self, val: usize, order: Ordering) -> usize
Maximum with the current value.
impl Atomic<u128>
[src]
impl Atomic<u128>
pub fn fetch_min(&self, val: u128, order: Ordering) -> u128
[src]
pub fn fetch_min(&self, val: u128, order: Ordering) -> u128
Minimum with the current value.
pub fn fetch_max(&self, val: u128, order: Ordering) -> u128
[src]
pub fn fetch_max(&self, val: u128, order: Ordering) -> u128
Maximum with the current value.
Trait Implementations
impl<T: Copy + Send> Sync for Atomic<T>
[src]
impl<T: Copy + Send> Sync for Atomic<T>
impl<T: Copy + Default> Default for Atomic<T>
[src]
impl<T: Copy + Default> Default for Atomic<T>
impl<T: Copy + Debug> Debug for Atomic<T>
[src]
impl<T: Copy + Debug> Debug for Atomic<T>