core::sync::atomic::AtomicPtr - Rust
Description: API documentation for the Rust `AtomicPtr` struct in crate `core`.
Keywords: rust, rustlang, rust-lang, AtomicPtr

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

    #[repr(C, align(4))]pub struct AtomicPtr<T> { /* fields omitted */ }

A raw pointer type which can be safely shared between threads.

This type has the same in-memory representation as a `*mut T`.

Note: This type is only available on platforms that support atomic loads and stores of pointers. Its size depends on the target pointer's size.

## Implementations

### `impl<T> AtomicPtr<T>`[src]

#### `pub const fn new(p: *mut T) -> AtomicPtr<T>`[src]

Creates a new `AtomicPtr`.

# Examples

    use std::sync::atomic::AtomicPtr;

    let ptr = &mut 5;
    let atomic_ptr  = AtomicPtr::new(ptr);

Run

#### `pub fn get_mut(&mut self) -> &mut *mut T`1.15.0[src]

Returns a mutable reference to the underlying pointer.

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

# Examples

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

    let mut atomic_ptr = AtomicPtr::new(&mut 10);
    *atomic_ptr.get_mut() = &mut 5;
    assert_eq!(unsafe { *atomic_ptr.load(Ordering::SeqCst) }, 5);

Run

#### `pub fn from_mut(v: &mut *mut T) -> &Self`[src]

🔬 This is a nightly-only experimental API. (`atomic_from_mut` #76314)

Get atomic access to a pointer.

# Examples

    #![feature(atomic_from_mut)]
    use std::sync::atomic::{AtomicPtr, Ordering};

    let mut some_ptr = &mut 123 as *mut i32;
    let a = AtomicPtr::from_mut(&mut some_ptr);
    a.store(&mut 456, Ordering::Relaxed);
    assert_eq!(unsafe { *some_ptr }, 456);

Run

#### `pub fn into_inner(self) -> *mut T`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::AtomicPtr;

    let atomic_ptr = AtomicPtr::new(&mut 5);
    assert_eq!(unsafe { *atomic_ptr.into_inner() }, 5);

Run

#### `pub fn load(&self, order: Ordering) -> *mut T`[src]

Loads a value from the pointer.

`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::{AtomicPtr, Ordering};

    let ptr = &mut 5;
    let some_ptr  = AtomicPtr::new(ptr);

    let value = some_ptr.load(Ordering::Relaxed);

Run

#### `pub fn store(&self, ptr: *mut T, order: Ordering)`[src]

Stores a value into the pointer.

`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::{AtomicPtr, Ordering};

    let ptr = &mut 5;
    let some_ptr  = AtomicPtr::new(ptr);

    let other_ptr = &mut 10;

    some_ptr.store(other_ptr, Ordering::Relaxed);

Run

#### `pub fn swap(&self, ptr: *mut T, order: Ordering) -> *mut T`[src]

Stores a value into the pointer, 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`.

Note: This method is only available on platforms that support atomic operations on pointers.

# Examples

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

    let ptr = &mut 5;
    let some_ptr  = AtomicPtr::new(ptr);

    let other_ptr = &mut 10;

    let value = some_ptr.swap(other_ptr, Ordering::Relaxed);

Run

#### `pub fn compare_and_swap(
&self,
current: *mut T,
new: *mut T,
order: Ordering
) -> *mut T`[src]

Stores a value into the pointer 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`.

Note: This method is only available on platforms that support atomic operations on pointers.

# Examples

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

    let ptr = &mut 5;
    let some_ptr  = AtomicPtr::new(ptr);

    let other_ptr   = &mut 10;

    let value = some_ptr.compare_and_swap(ptr, other_ptr, Ordering::Relaxed);

Run

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

Stores a value into the pointer 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.

Note: This method is only available on platforms that support atomic operations on pointers.

# Examples

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

    let ptr = &mut 5;
    let some_ptr  = AtomicPtr::new(ptr);

    let other_ptr   = &mut 10;

    let value = some_ptr.compare_exchange(ptr, other_ptr,
                                          Ordering::SeqCst, Ordering::Relaxed);

Run

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

Stores a value into the pointer if the current value is the same as the `current` value.

Unlike `AtomicPtr::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.

Note: This method is only available on platforms that support atomic operations on pointers.

# Examples

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

    let some_ptr = AtomicPtr::new(&mut 5);

    let new = &mut 10;
    let mut old = some_ptr.load(Ordering::Relaxed);
    loop {
        match some_ptr.compare_exchange_weak(old, new, Ordering::SeqCst, Ordering::Relaxed) {
            Ok(_) => break,
            Err(x) => old = x,
        }
    }

Run

## Trait Implementations

### `impl<T> Debug for AtomicPtr<T>`1.3.0[src]

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

Formats the value using the given formatter. Read more

### `impl<T> Default for AtomicPtr<T>`[src]

#### `fn default() -> AtomicPtr<T>`[src]

Creates a null `AtomicPtr<T>`.

### `impl<T> From<*mut T> for AtomicPtr<T>`1.23.0[src]

#### `fn from(p: *mut T) -> Self`[src]

Performs the conversion.

### `impl<T> Pointer for AtomicPtr<T>`1.24.0[src]

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

Formats the value using the given formatter.

### `impl<T> Send for AtomicPtr<T>`[src]

### `impl<T> Sync for AtomicPtr<T>`[src]

## Auto Trait Implementations

### `impl<T> Unpin for AtomicPtr<T>`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&Self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&Self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut Self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(Self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `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]

Performs the conversion.