Struct MutexWithTimeout

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

A wrapper around std::sync::Mutex that allows for a timeout to be set.

Implementations

impl<T> MutexWithTimeout<T>

pub fn new(inner: T) -> Self

Creates a new MutexWithTimeout with the default timeout.

pub fn new_with_timeout(inner: T, timeout: Duration) -> Self

Creates a new MutexWithTimeout with the given timeout.

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

Will attempt to lock the inner std::sync::Mutex. If the lock is not acquired within the timeout, None will be returned.

pub fn try_lock(&self) -> Option<MutexGuard<'_, T>>

Calls the inner mutex’s try_lock method.