Struct std::sync::atomic::AtomicPtrStable

pub struct AtomicPtr<T> {
    // some fields omitted
}

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

Methods

impl<T> AtomicPtr<T>

fn new(p: *mut T) -> AtomicPtr<T>

Creates a new AtomicPtr.

Examples

fn main() { use std::sync::atomic::AtomicPtr; let ptr = &mut 5i; let atomic_ptr = AtomicPtr::new(ptr); }

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

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

fn load(&self, order: Ordering) -> *mut T

Loads a value from the pointer.

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

Panics

Panics if order is Release or AcqRel.

Examples

fn main() { use std::sync::atomic::{AtomicPtr, Ordering}; let ptr = &mut 5i; let some_ptr = AtomicPtr::new(ptr); let value = some_ptr.load(Ordering::Relaxed); }

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

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

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

fn store(&self, ptr: *mut T, order: Ordering)

Stores a value into the pointer.

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

Examples

fn main() { use std::sync::atomic::{AtomicPtr, Ordering}; let ptr = &mut 5i; let some_ptr = AtomicPtr::new(ptr); let other_ptr = &mut 10i; some_ptr.store(other_ptr, Ordering::Relaxed); }

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

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

let other_ptr = &mut 10i;

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

Panics

Panics if order is Acquire or AcqRel.

fn swap(&self, ptr: *mut T, order: Ordering) -> *mut T

Stores a value into the pointer, returning the old value.

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

Examples

fn main() { use std::sync::atomic::{AtomicPtr, Ordering}; let ptr = &mut 5i; let some_ptr = AtomicPtr::new(ptr); let other_ptr = &mut 10i; let value = some_ptr.swap(other_ptr, Ordering::Relaxed); }

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

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

let other_ptr = &mut 10i;

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

fn compare_and_swap(&self, old: *mut T, new: *mut T, order: Ordering) -> *mut T

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

If the return value is equal to old then the value was updated.

compare_and_swap also takes an Ordering argument which describes the memory ordering of this operation.

Examples

fn main() { use std::sync::atomic::{AtomicPtr, Ordering}; let ptr = &mut 5i; let some_ptr = AtomicPtr::new(ptr); let other_ptr = &mut 10i; let another_ptr = &mut 10i; let value = some_ptr.compare_and_swap(other_ptr, another_ptr, Ordering::Relaxed); }

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

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

let other_ptr   = &mut 10i;
let another_ptr = &mut 10i;

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

Trait Implementations

impl<T> Sync for AtomicPtr<T>