# Struct core::sync::atomic::AtomicUsize 1.0.0 [−] [src]

    pub struct AtomicUsize { /* fields omitted */ }

An integer type which can be safely shared between threads.

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

## Methods

### `impl AtomicUsize`
[src]

#### `const fn new(v: usize) -> Self`
[src]

Creates a new atomic integer.

# Examples

    use std::sync::atomic::AtomicIsize;

    let atomic_forty_two  = AtomicIsize::new(42);Run

#### `fn get_mut(&mut self) -> &mut usize`
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_isize = AtomicIsize::new(10);
    assert_eq!(*some_isize.get_mut(), 10);
    *some_isize.get_mut() = 5;
    assert_eq!(some_isize.load(Ordering::SeqCst), 5);Run

#### `fn into_inner(self) -> usize`
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_isize = AtomicIsize::new(5);
    assert_eq!(some_isize.into_inner(), 5);Run

#### `fn load(&self, order: Ordering) -> usize`
[src]

Loads a value from the atomic integer.

`load` takes an `Ordering` argument which describes the memory ordering of this operation.

# Panics

Panics if `order` is `Release` or `AcqRel`.

# Examples

    use std::sync::atomic::{AtomicIsize, Ordering};

    let some_isize = AtomicIsize::new(5);

    assert_eq!(some_isize.load(Ordering::Relaxed), 5);Run

#### `fn store(&self, val: usize, order: Ordering)`
[src]

Stores a value into the atomic integer.

`store` takes an `Ordering` argument which describes the memory ordering of this operation.

# Examples

    use std::sync::atomic::{AtomicIsize, Ordering};

    let some_isize = AtomicIsize::new(5);

    some_isize.store(10, Ordering::Relaxed);
    assert_eq!(some_isize.load(Ordering::Relaxed), 10);Run

# Panics

Panics if `order` is `Acquire` or `AcqRel`.

#### `fn swap(&self, val: usize, order: Ordering) -> usize`
[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.

# Examples

    use std::sync::atomic::{AtomicIsize, Ordering};

    let some_isize = AtomicIsize::new(5);

    assert_eq!(some_isize.swap(10, Ordering::Relaxed), 5);Run

#### `fn compare_and_swap(&self, current: usize, new: usize, order: Ordering) -> usize`
[src]

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.

# Examples

    use std::sync::atomic::{AtomicIsize, Ordering};

    let some_isize = AtomicIsize::new(5);

    assert_eq!(some_isize.compare_and_swap(5, 10, Ordering::Relaxed), 5);
    assert_eq!(some_isize.load(Ordering::Relaxed), 10);

    assert_eq!(some_isize.compare_and_swap(6, 12, Ordering::Relaxed), 10);
    assert_eq!(some_isize.load(Ordering::Relaxed), 10);Run

#### `fn compare_exchange(
&self,
current: usize,
new: usize,
success: Ordering,
failure: Ordering
) -> Result<usize, usize>`
1.10.0
[src]

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. The failure ordering can't be `Release` or `AcqRel` and must be equivalent or weaker than the success ordering.

# Examples

    use std::sync::atomic::{AtomicIsize, Ordering};

    let some_isize = AtomicIsize::new(5);

    assert_eq!(some_isize.compare_exchange(5, 10,
                                           Ordering::Acquire,
                                           Ordering::Relaxed),
               Ok(5));
    assert_eq!(some_isize.load(Ordering::Relaxed), 10);

    assert_eq!(some_isize.compare_exchange(6, 12,
                                           Ordering::SeqCst,
                                           Ordering::Acquire),
               Err(10));
    assert_eq!(some_isize.load(Ordering::Relaxed), 10);Run

#### `fn compare_exchange_weak(
&self,
current: usize,
new: usize,
success: Ordering,
failure: Ordering
) -> Result<usize, usize>`
1.10.0
[src]

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. The failure ordering can't be `Release` or `AcqRel` and must be equivalent 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

#### `fn fetch_add(&self, val: usize, order: Ordering) -> usize`
[src]

Adds to the current value, returning the previous value.

This operation wraps around on overflow.

# 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

#### `fn fetch_sub(&self, val: usize, order: Ordering) -> usize`
[src]

Subtracts from the current value, returning the previous value.

This operation wraps around on overflow.

# Examples

    use std::sync::atomic::{AtomicIsize, Ordering};

    let foo = AtomicIsize::new(0);
    assert_eq!(foo.fetch_sub(10, Ordering::SeqCst), 0);
    assert_eq!(foo.load(Ordering::SeqCst), -10);Run

#### `fn fetch_and(&self, val: usize, order: Ordering) -> usize`
[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.

# 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

#### `fn fetch_or(&self, val: usize, order: Ordering) -> usize`
[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.

# 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

#### `fn fetch_xor(&self, val: usize, order: Ordering) -> usize`
[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.

# 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

## Trait Implementations

### `impl Default for AtomicUsize`
[src]

#### `fn default() -> Self`
[src]

Returns the "default value" for a type. Read more

### `impl Debug for AtomicUsize`
1.3.0
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl Sync for AtomicUsize`
[src]

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)