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> Deref for BoxRcu<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.