Struct rcu_clean::BoxRcu

pub struct BoxRcu<T> { /* private fields */ }

An owned pointer that allows interior mutability

An BoxRcu is currently the size of two pointers (plus the allocated data). So one pointer of overhead versus a plain old Box. You will probably want to to occasionally call [clean] to free up copies made when you call update. Or you could just leak memory, that’s cool too.

Our benchmark oddly shows BoxRcu reads as being faster than reads using Box. I don’t understand this, or particularly believe it.

let x = rcu_clean::BoxRcu::new(3);
let y: &usize = &(*x);
*x.update() = 7; // Wow, we are mutating something we have borrowed!
assert_eq!(*y, 3); // the old reference is still valid.
assert_eq!(*x, 7); // but the pointer now points to the new value.

Implementations

impl<'a, T: Clone> BoxRcu<T>

pub fn new(x: T) -> Self

pub fn update(&'a self) -> Guard<'a, T>

pub fn clean(&mut self)

Trait Implementations

impl<T> Borrow<T> for BoxRcu<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Debug> Debug for BoxRcu<T>

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

Formats the value using the given formatter.

impl<T> Deref for BoxRcu<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Display> Display for BoxRcu<T>

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

Formats the value using the given formatter.

impl<T: Ord> Ord for BoxRcu<T>

fn cmp(&self, other: &BoxRcu<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<BoxRcu<T>> for BoxRcu<T>

fn eq(&self, other: &BoxRcu<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd<BoxRcu<T>> for BoxRcu<T>

fn partial_cmp(&self, other: &BoxRcu<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for BoxRcu<T>