Struct peril::HazardValue

pub struct HazardValue<'registry, T: Send + 'registry>(_);

encapsulates a boxed Value or a Dummy (like null)

Examples

use peril::HazardValue;

// creating a boxed string value
let boxed = HazardValue::boxed("test");

// creating a dummy nullptr
let dummy = HazardValue::<usize>::dummy(0);

Implementations

impl<'registry, T: Send + 'registry> HazardValue<'registry, T>

pub fn boxed(value: T) -> HazardValue<'registry, T>

create a boxed HazardValue

Arguments

• value - A generic value held within the box

Examples

use peril::HazardValue;

// creating a boxed string value
let boxed = HazardValue::boxed("test");

pub fn dummy(value: usize) -> HazardValue<'registry, T>

create a Dummy HazardValue (like null)

Arguments

• value - the dummy pointer value (usually used for null values)

Examples

use peril::HazardValue;

// creating a dummy nullptr
let dummy = HazardValue::<usize>::dummy(0);

pub fn as_ref(&self) -> Option<&T>

read the data from a Boxed HazardValue and will return None if the value is a dummy

Examples

use peril::HazardValue;

// creating a boxed string value
let boxed = HazardValue::boxed("test");
assert!(boxed.as_ref().unwrap() == &"test");

pub fn is_boxed(&self) -> bool

check if a value is a Boxed HazardValue

Examples

use peril::HazardValue;

// creating a boxed string value
let boxed = HazardValue::boxed("test");
assert!(boxed.is_boxed());

pub fn is_dummy(&self) -> bool

check if a value is a Dummy HazardValue

Examples

use peril::HazardValue;

// creating a dummy value
let dummy = HazardValue::<usize>::dummy(0);
assert!(dummy.is_dummy());

pub fn as_dummy(&self) -> Option<usize>

get the (pointer) dummy value of HazardValue or return None if the value is not a dummy

Examples

use peril::HazardValue;

// creating a dummy value
let dummy = HazardValue::<usize>::dummy(1337);
assert!(dummy.as_dummy().unwrap() == 1337);

pub fn clone_inner(self) -> Option<T> where
    T: Clone, 

clones the data from a Boxed HazardValue if T: Clone or return None if the value is a dummy

Examples

use peril::HazardValue;

// creating a boxed value
let mut boxed = HazardValue::boxed(1);
let taken = boxed.clone_inner().unwrap();
assert!(taken == 1);

Trait Implementations

impl<'registry, T: Send + 'registry> Clone for HazardValue<'registry, T>

pub fn clone(&self) -> Self

clones the HazardValue itself

Examples

use peril::{HazardRegistry, HazardValue, HazardRecord, HazardPointer, Ordering};

// creating a boxed value
let boxed = HazardValue::boxed(1);
let clone = boxed.clone();

let registry = HazardRegistry::default();
let hp = HazardPointer::new(boxed, &registry);
let ok = hp.compare_exchange(clone, HazardValue::dummy(0), Ordering::Relaxed, Ordering::Relaxed).is_ok();
assert!(ok);

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.