Struct widerwlock::WideRwLock

pub struct WideRwLock<T: ?Sized> { /* private fields */ }

A multi-reader, single writer lock.

The implementation has the following properties:

• Non-reentrant. Do no attempt to take this lock multiple times in the same thread. It will deadlock.
• Writer preferenced: writers will get preference and hold back incoming readers when waiting.
• 8x partitioned: allows very fast multi-reader locking.
• Uncontended single threaded performance better than std::sync::Mutex and std::sync:RwLock
• No poisoning. It should be possible to wrap this lock with poison support if needed.

This struct uses a single pointer to point into a 576 byte (64-byte aligned) heap area

Implementations

impl<T> WideRwLock<T>

pub fn new(data: T) -> WideRwLock<T>

creates a new lock

impl<T: ?Sized> WideRwLock<T>

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

Obtain a read lock. Multiple simultaneous read locks will be given if there are no writers waiting. The lock remains locked until the returned RAII guard is dropped.

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

Obtain a write lock. If a writer is waiting, no more read locks will be given until the writer has been granted access and finished. The lock remains locked until the returned RAII guard is dropped.

Trait Implementations

impl<T: ?Sized> Drop for WideRwLock<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Send> Send for WideRwLock<T>

impl<T: ?Sized + Send + Sync> Sync for WideRwLock<T>