Struct KeyLock

pub struct KeyLock<K> { /* private fields */ }

A lock, that locks based on a key, but lets other keys lock separately. Based on a HashMap of Mutexes.

Implementations

impl<K> KeyLock<K>

where K: Eq + Hash + Send + Clone,

pub fn new() -> Self

Create new instance of a KeyLock

pub async fn lock(&self, key: K) -> OwnedMutexGuard<()>

Lock this key, returning a guard. Cleans up locks every 1000 accesses.

pub async fn try_lock( &self, key: K, ) -> Result<OwnedMutexGuard<()>, TryLockError>

Try lock this key, returning immediately. Cleans up locks every 1000 accesses.

pub fn blocking_lock(&self, key: K) -> OwnedMutexGuard<()>

Lock this key blockingly, returning a guard. Cleans up locks every 1000 accesses.

pub fn blocking_try_lock( &self, key: K, ) -> Result<OwnedMutexGuard<()>, TryLockError>

Try lock this key blockingly, returning immediately. Cleans up locks every 1000 accesses.

pub async fn clean(&self)

Clean up by removing locks that are not locked.

pub fn blocking_clean(&self)

Cleanu up by removing locks that are not locked, but lock blockingly.

Trait Implementations

impl<K: Debug> Debug for KeyLock<K>

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

Formats the value using the given formatter.

impl<K> Default for KeyLock<K>

fn default() -> Self

Returns the “default value” for a type.