Struct closeable_mutex::CloseableMutex

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

A mutex that can be closed.

A closed mutex can be accessed freely by the owner, but while closed it cannot be locked by anyone else.

Implementations

impl<T> CloseableMutex<T>

pub fn new(value: T) -> Self

Returns a new instance wrapping the given value.

impl<T: ?Sized> CloseableMutex<T>

pub fn close(self: Arc<Self>) -> ClosedGuard<T>

Closes the mutex, returning a guard that can be used to access the underlying value.

When the guard is dropped, the mutex is re-opened.

While the mutex is closed, calls to lock_if_open will return None, and calls to lock will panic.

pub fn lock_if_open(&self) -> Option<OpenGuard<'_, T>>

If the lock is open, waits for it to become available and returns a guard that can be used to access the underlying value.

If the lock is closed, returns None.

pub fn lock(&self) -> OpenGuard<'_, T>

Waits for the lock to become available and returns a guard that can be used to access the underlying value.

Panics

Panics if the lock is closed. To avoid this, use lock_if_open.

Trait Implementations

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