Struct LockManager

pub struct LockManager { /* private fields */ }

A lock manager to create “managed” locks.

Managed lock’s lifecycle is managed by the lock manager background thread, that includes: - Automatic lease refresh - Lock revocation when the lock is dropped

You can clone LockManager to share it across threads, it is really cheap to do so.

See spawn_lock_manager to create a new lock manager.

Implementations

impl LockManager

pub async fn try_lock<S>( &self, name: S, lease_duration: Duration, ) -> Result<ManagedLock, TryLockError>

where S: AsRef<str>,

Tries to lock a key with automatic lease refresh and lock revocation when dropped.

If the key is already held by another lock, it will return an error immediately.

pub async fn try_lock_with_lease<S>( &self, name: S, managed_lease: ManagedLease, ) -> Result<ManagedLock, TryLockError>

where S: AsRef<str>,

Similar to LockManager::try_lock but with a custom lease.

pub async fn lock<S>( &self, name: S, lease_duration: Duration, ) -> Result<ManagedLock, Error>

where S: AsRef<str>,

Locks a key with automatic lease refresh and lock revocation when dropped. If the key is already held by another lock, it will wait until the lock is released.

Be aware this method can await indefinitely if the key is never released.

pub async fn lock_with_lease<S>( &self, name: S, managed_lease: ManagedLease, ) -> Result<ManagedLock, Error>

where S: AsRef<str>,

Similar to LockManager::lock but with a custom lease.

Trait Implementations

impl Clone for LockManager

fn clone(&self) -> LockManager

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.