Struct RcuBox 

pub struct RcuBox<T: Send + Sync + 'static> { /* private fields */ }

An RCU (Read-Copy-Update) wrapper around a Box.

The Box can be dereferenced from multiple threads concurrently without blocking. When the Box is replaced, reads may continue to see the old Box pointer for some period of time.

Implementations

impl<T: Send + Sync + 'static> RcuBox<T>

pub fn new(data: T) -> Self

Create a new RCU wrapped Box from a value.

pub fn read(&self) -> RcuReadGuard<T>

Read the value of the wrapped Box.

The object referenced by the Box will remain valid until the RcuReadGuard is dropped. However, another thread running concurrently might see a different object.

pub fn as_ref<'a>(&self, scope: &'a RcuReadScope) -> &'a T

Returns a reference to the value of the wrapped Box.

The object referenced by the Box will remain valid until the RcuReadScope is dropped. However, another thread running concurrently might see a different object.

pub fn update(&self, data: T)

Write a new Boxed value to the RCU wrapper.

Concurrent readers may continue to see the old boxed object until the RCU state machine has made sufficient progress to ensure that no concurrent readers are holding read guards.

impl<T: Clone + Send + Sync + 'static> RcuBox<T>

pub fn cloned(&self) -> T

Returns a clone of the value of the wrapped Box.

The clone is detached from any RCU read scope.

Trait Implementations

impl<T: Clone + Send + Sync + 'static> Clone for RcuBox<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Send + Sync + 'static> Debug for RcuBox<T>

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

Formats the value using the given formatter.

impl<T: Default + Send + Sync + 'static> Default for RcuBox<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Send + Sync + 'static> Drop for RcuBox<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: Send + Sync + 'static> From<Box<T>> for RcuBox<T>

fn from(value: Box<T>) -> Self

Converts to this type from the input type.