Struct Monitor

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

A convenience wrapper around a SharedMutex and a Condvar.

Provides an ergonomic API for locking and waiting on predicates associated with the internal data.

Implementations

impl<T> Monitor<T>

pub fn new(val: T) -> Monitor<T>

Create a new Monitor.

impl<T: ?Sized> Monitor<T>

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

Acquire a shared read lock on the monitor.

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

Acquire an exclusive write lock on the monitor.

pub fn notify_one(&self)

Notify one thread which is waiting on the monitor.

Note that it is safe but often incorrect to notify without holding any lock on the monitor, since the predicate may change between a notification and a predicate check, potentially causing a deadlock.

pub fn notify_all(&self)

Notify all threads which are waiting on the monitor.

Note that it is safe but often incorrect to notify without holding any lock on the monitor, since the predicate may change between a notification and a predicate check, potentially causing a deadlock.

pub fn cond(&self) -> &Condvar

Get a reference to the condition variable in this Monitor for external use.

Trait Implementations

impl<T: ?Sized> AsMut<SharedMutex<T>> for Monitor<T>

fn as_mut(&mut self) -> &mut SharedMutex<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ?Sized> AsRef<SharedMutex<T>> for Monitor<T>

fn as_ref(&self) -> &SharedMutex<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ?Sized + Debug> Debug for Monitor<T>

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

Formats the value using the given formatter.

impl<T> Into<SharedMutex<T>> for Monitor<T>

fn into(self) -> SharedMutex<T>

Converts this type into the (usually inferred) input type.