Struct atomicbox_nostd::AtomicBox

pub struct AtomicBox<T> { /* fields omitted */ }

A type that holds a single Box<T> value and can be safely shared between threads.

Implementations

impl<T> AtomicBox<T>

pub fn new(value: Box<T>) -> AtomicBox<T>

Creates a new AtomicBox with the given value.

Examples

use atomicbox::AtomicBox;

let atomic_box = AtomicBox::new(Box::new(0));

pub fn swap(&self, other: Box<T>, order: Ordering) -> Box<T>

Atomically set this AtomicBox to other and return the previous value.

This does not allocate or free memory, and it neither clones nor drops any values. other is moved into self; the value previously in self is returned.

ordering must be either Ordering::AcqRel or Ordering::SeqCst, as other values would not be safe if T contains any data.

Panics

Panics if ordering is not one of the two allowed values.

Examples

use std::sync::atomic::Ordering;
use atomicbox::AtomicBox;

let atom = AtomicBox::new(Box::new("one"));
let prev_value = atom.swap(Box::new("two"), Ordering::AcqRel);
assert_eq!(*prev_value, "one");

pub fn swap_mut(&self, other: &mut Box<T>, order: Ordering)

Atomically swaps the contents of this AtomicBox with the contents of other.

This does not allocate or free memory, and it neither clones nor drops any values. The pointers in *other and self are simply exchanged.

ordering must be either Ordering::AcqRel or Ordering::SeqCst, as other values would not be safe if T contains any data.

Panics

Panics if ordering is not one of the two allowed values.

Examples

use std::sync::atomic::Ordering;
use atomicbox::AtomicBox;

let atom = AtomicBox::new(Box::new("one"));
let mut boxed = Box::new("two");
atom.swap_mut(&mut boxed, Ordering::AcqRel);
assert_eq!(*boxed, "one");

pub fn into_inner(self) -> Box<T>

Consume this AtomicBox, returning the last box value it contained.

Examples

use atomicbox::AtomicBox;

let atom = AtomicBox::new(Box::new("hello"));
assert_eq!(atom.into_inner(), Box::new("hello"));

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the contained value.

This is safe because it borrows the AtomicBox mutably, which ensures that no other threads can concurrently access either the atomic pointer field or the boxed data it points to.

Trait Implementations

impl<T> Debug for AtomicBox<T>

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

The {:?} format of an AtomicBox<T> looks like "AtomicBox(0x12341234)".

impl<T> Default for AtomicBox<T> where
    Box<T>: Default, 

fn default() -> AtomicBox<T>

The default AtomicBox<T> value boxes the default T value.

impl<T> Drop for AtomicBox<T>

fn drop(&mut self)

Dropping an AtomicBox<T> drops the final Box<T> value stored in it.

impl<T: Send> Send for AtomicBox<T>

impl<T: Sync> Sync for AtomicBox<T>