1.0.0[−][src]Struct std::sync::atomic::AtomicIsize
An integer type which can be safely shared between threads.
This type has the same in-memory representation as the underlying
integer type, isize
. For more about the differences between atomic types and
non-atomic types as well as information about the portability of
this type, please see the module-level documentation.
Methods
impl AtomicIsize
[src]
pub const fn new(v: isize) -> AtomicIsize
[src]
Creates a new atomic integer.
Examples
use std::sync::atomic::AtomicIsize; let atomic_forty_two = AtomicIsize::new(42);Run
pub fn get_mut(&mut self) -> &mut isize
1.15.0[src]
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.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let mut some_var = AtomicIsize::new(10); assert_eq!(*some_var.get_mut(), 10); *some_var.get_mut() = 5; assert_eq!(some_var.load(Ordering::SeqCst), 5);Run
pub fn into_inner(self) -> isize
1.15.0[src]
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.
Examples
use std::sync::atomic::AtomicIsize; let some_var = AtomicIsize::new(5); assert_eq!(some_var.into_inner(), 5);Run
pub fn load(&self, order: Ordering) -> isize
[src]
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let some_var = AtomicIsize::new(5); assert_eq!(some_var.load(Ordering::Relaxed), 5);Run
pub fn store(&self, val: isize, order: Ordering)
[src]
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let some_var = AtomicIsize::new(5); some_var.store(10, Ordering::Relaxed); assert_eq!(some_var.load(Ordering::Relaxed), 10);Run
pub fn swap(&self, val: isize, order: Ordering) -> isize
[src]
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let some_var = AtomicIsize::new(5); assert_eq!(some_var.swap(10, Ordering::Relaxed), 5);Run
pub fn compare_and_swap(
&self,
current: isize,
new: isize,
order: Ordering
) -> isize
[src]
&self,
current: isize,
new: isize,
order: Ordering
) -> isize
Stores a value into the atomic integer if the current value is the same as
the current
value.
The return value is always the previous value. If it is equal to current
, then the
value was updated.
compare_and_swap
also takes an Ordering
argument which describes the memory
ordering of this operation. Notice that even when using AcqRel
, the operation
might fail and hence just perform an Acquire
load, but not have Release
semantics.
Using Acquire
makes the store part of this operation Relaxed
if it
happens, and using Release
makes the load part Relaxed
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let some_var = AtomicIsize::new(5); assert_eq!(some_var.compare_and_swap(5, 10, Ordering::Relaxed), 5); assert_eq!(some_var.load(Ordering::Relaxed), 10); assert_eq!(some_var.compare_and_swap(6, 12, Ordering::Relaxed), 10); assert_eq!(some_var.load(Ordering::Relaxed), 10);Run
pub fn compare_exchange(
&self,
current: isize,
new: isize,
success: Ordering,
failure: Ordering
) -> Result<isize, isize>
1.10.0[src]
&self,
current: isize,
new: isize,
success: Ordering,
failure: Ordering
) -> Result<isize, isize>
Stores a value into the atomic integer 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
current
.
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. Using Acquire
as success ordering makes the store part
of this operation Relaxed
, and using Release
makes the successful load
Relaxed
. The failure ordering can only be SeqCst
, Acquire
or Relaxed
and must be equivalent to or weaker than the success ordering.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let some_var = AtomicIsize::new(5); assert_eq!(some_var.compare_exchange(5, 10, Ordering::Acquire, Ordering::Relaxed), Ok(5)); assert_eq!(some_var.load(Ordering::Relaxed), 10); assert_eq!(some_var.compare_exchange(6, 12, Ordering::SeqCst, Ordering::Acquire), Err(10)); assert_eq!(some_var.load(Ordering::Relaxed), 10);Run
pub fn compare_exchange_weak(
&self,
current: isize,
new: isize,
success: Ordering,
failure: Ordering
) -> Result<isize, isize>
1.10.0[src]
&self,
current: isize,
new: isize,
success: Ordering,
failure: Ordering
) -> Result<isize, isize>
Stores a value into the atomic integer 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_weak
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. Using Acquire
as success ordering makes the store part
of this operation Relaxed
, and using Release
makes the successful load
Relaxed
. The failure ordering can only be SeqCst
, Acquire
or Relaxed
and must be equivalent to or weaker than the success ordering.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let val = AtomicIsize::new(4); let mut old = val.load(Ordering::Relaxed); loop { let new = old * 2; match val.compare_exchange_weak(old, new, Ordering::SeqCst, Ordering::Relaxed) { Ok(_) => break, Err(x) => old = x, } }Run
pub fn fetch_add(&self, val: isize, order: Ordering) -> isize
[src]
Adds to the current value, returning the previous value.
This operation wraps around on overflow.
fetch_add
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(0); assert_eq!(foo.fetch_add(10, Ordering::SeqCst), 0); assert_eq!(foo.load(Ordering::SeqCst), 10);Run
pub fn fetch_sub(&self, val: isize, order: Ordering) -> isize
[src]
Subtracts from the current value, returning the previous value.
This operation wraps around on overflow.
fetch_sub
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(20); assert_eq!(foo.fetch_sub(10, Ordering::SeqCst), 20); assert_eq!(foo.load(Ordering::SeqCst), 10);Run
pub fn fetch_and(&self, val: isize, order: Ordering) -> isize
[src]
Bitwise "and" with the current value.
Performs a bitwise "and" operation on the current value and the argument val
, and
sets the new value to the result.
Returns the previous value.
fetch_and
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(0b101101); assert_eq!(foo.fetch_and(0b110011, Ordering::SeqCst), 0b101101); assert_eq!(foo.load(Ordering::SeqCst), 0b100001);Run
pub fn fetch_nand(&self, val: isize, order: Ordering) -> isize
1.27.0[src]
Bitwise "nand" with the current value.
Performs a bitwise "nand" operation on the current value and the argument val
, and
sets the new value to the result.
Returns the previous value.
fetch_nand
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(0x13); assert_eq!(foo.fetch_nand(0x31, Ordering::SeqCst), 0x13); assert_eq!(foo.load(Ordering::SeqCst), !(0x13 & 0x31));Run
pub fn fetch_or(&self, val: isize, order: Ordering) -> isize
[src]
Bitwise "or" with the current value.
Performs a bitwise "or" operation on the current value and the argument val
, and
sets the new value to the result.
Returns the previous value.
fetch_or
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(0b101101); assert_eq!(foo.fetch_or(0b110011, Ordering::SeqCst), 0b101101); assert_eq!(foo.load(Ordering::SeqCst), 0b111111);Run
pub fn fetch_xor(&self, val: isize, order: Ordering) -> isize
[src]
Bitwise "xor" with the current value.
Performs a bitwise "xor" operation on the current value and the argument val
, and
sets the new value to the result.
Returns the previous value.
fetch_xor
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
.
Examples
use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(0b101101); assert_eq!(foo.fetch_xor(0b110011, Ordering::SeqCst), 0b101101); assert_eq!(foo.load(Ordering::SeqCst), 0b011110);Run
pub fn fetch_update<F>(
&self,
f: F,
fetch_order: Ordering,
set_order: Ordering
) -> Result<isize, isize> where
F: FnMut(isize) -> Option<isize>,
[src]
&self,
f: F,
fetch_order: Ordering,
set_order: Ordering
) -> Result<isize, isize> where
F: FnMut(isize) -> Option<isize>,
🔬 This is a nightly-only experimental API. (no_more_cas
#48655)
no more CAS loops in user code
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
but 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 loads
and failed updates while the second describes the required ordering when the
operation finally succeeds. Beware that this is different from the two
modes in compare_exchange
!
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
#![feature(no_more_cas)] use std::sync::atomic::{AtomicIsize, Ordering}; let x = AtomicIsize::new(7); assert_eq!(x.fetch_update(|_| None, Ordering::SeqCst, Ordering::SeqCst), Err(7)); assert_eq!(x.fetch_update(|x| Some(x + 1), Ordering::SeqCst, Ordering::SeqCst), Ok(7)); assert_eq!(x.fetch_update(|x| Some(x + 1), Ordering::SeqCst, Ordering::SeqCst), Ok(8)); assert_eq!(x.load(Ordering::SeqCst), 9);Run
pub fn fetch_max(&self, val: isize, order: Ordering) -> isize
[src]
🔬 This is a nightly-only experimental API. (atomic_min_max
#48655)
easier and faster min/max than writing manual CAS loop
Maximum with the current value.
Finds the maximum of the current value and the argument val
, and
sets the new value to the result.
Returns the previous value.
fetch_max
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
.
Examples
#![feature(atomic_min_max)] use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(23); assert_eq!(foo.fetch_max(42, Ordering::SeqCst), 23); assert_eq!(foo.load(Ordering::SeqCst), 42);Run
If you want to obtain the maximum value in one step, you can use the following:
#![feature(atomic_min_max)] use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(23); let bar = 42; let max_foo = foo.fetch_max(bar, Ordering::SeqCst).max(bar); assert!(max_foo == 42);Run
pub fn fetch_min(&self, val: isize, order: Ordering) -> isize
[src]
🔬 This is a nightly-only experimental API. (atomic_min_max
#48655)
easier and faster min/max than writing manual CAS loop
Minimum with the current value.
Finds the minimum of the current value and the argument val
, and
sets the new value to the result.
Returns the previous value.
fetch_min
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
.
Examples
#![feature(atomic_min_max)] use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(23); assert_eq!(foo.fetch_min(42, Ordering::Relaxed), 23); assert_eq!(foo.load(Ordering::Relaxed), 23); assert_eq!(foo.fetch_min(22, Ordering::Relaxed), 23); assert_eq!(foo.load(Ordering::Relaxed), 22);Run
If you want to obtain the minimum value in one step, you can use the following:
#![feature(atomic_min_max)] use std::sync::atomic::{AtomicIsize, Ordering}; let foo = AtomicIsize::new(23); let bar = 12; let min_foo = foo.fetch_min(bar, Ordering::SeqCst).min(bar); assert_eq!(min_foo, 12);Run
Trait Implementations
impl From<isize> for AtomicIsize
1.23.0[src]
fn from(v: isize) -> AtomicIsize
[src]
Converts an isize
into an AtomicIsize
.
impl Default for AtomicIsize
[src]
fn default() -> AtomicIsize
[src]
impl Debug for AtomicIsize
1.3.0[src]
impl Sync for AtomicIsize
[src]
impl RefUnwindSafe for AtomicIsize
1.14.0[src]
Auto Trait Implementations
impl Send for AtomicIsize
Blanket Implementations
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,