Struct SynchronizedWriterRcu

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

An RCU (Read-Copy-Update) data structure that uses a Mutex to synchronize writers.

Implementations

impl<T> SynchronizedWriterRcu<T>

pub fn new(value: T) -> Self

Creates a new SingleWriterRcu with value.

pub fn read(&self) -> ReadGuard<'_, T>

Acquires a read guard on the RCU.

pub fn write(&self) -> WriteGuard<'_, T>

where T: Clone,

Acquires a write guard on the RCU by cloning T.

See [`WriteGuard::write_with``].

pub fn write_with<F: FnOnce(&T) -> T>(&self, f: F) -> WriteGuard<'_, T>

Acquires a write guard on the RCU.

[WriteGuard] provides mutable access to a new copy of the data kept by SingleWriterRcu via f.

Dropping the returned [WriteGuard] commits any changes back to the RCU. Changes may be discarded with [WriteGuard::discard].

pub fn replace(&self, value: T)

Replaces the value in the RCU with value without reading the current value.

WARNING: do NOT use this method with a value built from a clone of the data from [SingleWriterRcu::read], this is only meant to be used when the new value is produced independently of the previous value. The value may be changed by another thread between read and replace - these changes would be lost. Use [SingleWriterRcu::write] to ensure writer synchronization is applied.

Trait Implementations

impl<T: Default> Default for SynchronizedWriterRcu<T>

fn default() -> SynchronizedWriterRcu<T>

Returns the “default value” for a type.