Struct KeyedLock

pub struct KeyedLock<K: Eq + Hash + Clone + Send>(/* private fields */);

A lock that provides mutually exclusive access to a resource, where the resource is identified by a key.

Implementations

impl<K: Eq + Hash + Clone + Send> KeyedLock<K>

pub fn new() -> Self

Creates a new KeyedLock.

pub async fn lock<'a>(&'a self, key: K) -> Guard<'a, K>

Acquires a lock for a given key.

If the lock is already held by another task, this method will wait until the lock is released.

When the returned Guard is dropped, the lock is released.

pub async fn lock_owned(self: &Arc<Self>, key: K) -> OwnedGuard<K>

Acquires a lock for a given key, returning an OwnedGuard.

This method is for use with Arc<KeyedLock>. If the lock is already held by another task, this method will wait until the lock is released.

When the returned OwnedGuard is dropped, the lock is released.