Struct rcu_clean::ArcRcu

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

A thread-safe reference counted pointer that allows interior mutability

The ArcRcu is functionally roughly equivalent to Arc<RwLock<T>>, except that reads (of the old value) may happen while a write is taking place. Reads on an ArcRcu are much faster (by a factor of 2 or 3) than reads on either a Arc<RwLock<T>> or a Arc<Mutex<T>>. So in this case you gain both ergonomics and read speed. Writes are slow, so only use this type if writes are rare (or their speed doesn't matter).

let x = rcu_clean::ArcRcu::new(3);
let y: &usize = &(*x);
let z = x.clone();
*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.
assert_eq!(*z, 7); // but the cloned pointer also points to the new value.

Methods

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

pub fn new(x: T) -> Self

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

pub fn clean(&mut self)

Trait Implementations

impl<T: Eq> Eq for ArcRcu<T>

impl<T: Send + Sync> Send for ArcRcu<T>

impl<T: PartialOrd> PartialOrd<ArcRcu<T>> for ArcRcu<T>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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: Send + Sync> Sync for ArcRcu<T>

impl<T: PartialEq> PartialEq<ArcRcu<T>> for ArcRcu<T>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Clone> Clone for ArcRcu<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord> Ord for ArcRcu<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<T: Debug> Debug for ArcRcu<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for ArcRcu<T>

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

Formats the value using the given formatter.

impl<T> Deref for ArcRcu<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Borrow<T> for ArcRcu<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.