Struct atomicbox::AtomicOptionBox

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

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

Methods

impl<T> AtomicOptionBox<T>

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

Creates a new AtomicOptionBox with the given value.

Examples

use atomicbox::AtomicOptionBox;

let atomic_box = AtomicOptionBox::new(Some(Box::new(0)));

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

Atomically set this AtomicOptionBox 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::AtomicOptionBox;

let atom = AtomicOptionBox::new(None);
let prev_value = atom.swap(Some(Box::new("ok")), Ordering::AcqRel);
assert_eq!(prev_value, None);

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

Atomically swaps the contents of this AtomicOptionBox 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::AtomicOptionBox;

let atom = AtomicOptionBox::new(None);
let mut boxed = Some(Box::new("ok"));
let prev_value = atom.swap_mut(&mut boxed, Ordering::AcqRel);
assert_eq!(boxed, None);

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

Consume this AtomicOptionBox, returning the last option value it contained.

Examples

use atomicbox::AtomicOptionBox;

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

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

Returns a mutable reference to the contained value.

This is safe because it borrows the AtomicOptionBox 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> Drop for AtomicOptionBox<T>

fn drop(&mut self)

Dropping an AtomicOptionBox<T> drops the final Box<T> value (if any) stored in it.

impl<T> Default for AtomicOptionBox<T>

fn default() -> AtomicOptionBox<T>

The default AtomicOptionBox<T> value is AtomicBox::new(None).

impl<T> Debug for AtomicOptionBox<T>

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

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