Struct RwLock 

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

A wrapper around a reader-writer lock that tracks operations for deadlock detection

The RwLock provides the same API as a standard reader-writer lock but also notifies the detector on lock/unlock operations.

Implementations

impl<T> RwLock<T>

pub fn new(value: T) -> Self

Create a new tracked RwLock with a unique ID

Arguments

• value - The initial value to store in the lock

Returns

A new RwLock wrapping the provided value

Example

use deloxide::RwLock;
let lock = RwLock::new(42);

pub fn id(&self) -> LockId

Get the unique ID of this lock

pub fn creator_thread_id(&self) -> ThreadId

Get the creator thread ID

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

Acquire a shared (read) lock, tracking the attempt and acquisition

Uses two-phase locking protocol to eliminate race conditions between deadlock detection and lock acquisition.

Returns

A guard which releases the lock when dropped

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

Acquire an exclusive (write) lock, tracking the attempt and acquisition

Uses two-phase locking protocol to eliminate race conditions between deadlock detection and lock acquisition.

Returns

A guard which releases the lock when dropped

pub fn try_read(&self) -> Option<RwLockReadGuard<'_, T>>

Try to acquire a shared (read) lock, tracking the attempt

Uses atomic detection to ensure deadlock detection and acquisition happen together.

pub fn try_write(&self) -> Option<RwLockWriteGuard<'_, T>>

Try to acquire an exclusive (write) lock, tracking the attempt

Uses atomic detection to ensure deadlock detection and acquisition happen together.

pub fn into_inner(self) -> T

where T: Sized,

Consumes this RwLock, returning the underlying data

Example

use deloxide::RwLock;

let lock = RwLock::new(String::from("hello"));
let s = lock.into_inner();
assert_eq!(s, "hello");

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data

Since this call borrows the RwLock mutably, no actual locking needs to take place – the mutable borrow statically guarantees no locks exist.

Example

use deloxide::RwLock;

let mut lock = RwLock::new(0);
*lock.get_mut() = 10;
assert_eq!(*lock.read(), 10);

Trait Implementations

impl<T: Default> Default for RwLock<T>

fn default() -> RwLock<T>

Creates a new RwLock<T>, with the Default value for T

impl<T> Drop for RwLock<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for RwLock<T>

fn from(t: T) -> Self

Creates a new instance of an RwLock<T> which is unlocked This is equivalent to RwLock::new