Struct PostgresLock 

pub struct PostgresLock { /* private fields */ }

Available on crate feature postgres only.

Postgres-backed distributed lock.

Trait Implementations

impl DistributedLock for PostgresLock

fn try_acquire<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 AdvisoryKey, _ttl: Duration, ) -> Pin<Box<dyn Future<Output = PersistenceResult<Option<LockGuard>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Try once to acquire key with the given ttl. Returns Ok(Some(guard)) on success, Ok(None) when the key is currently held by another holder, and Err(_) for backend failure.

fn acquire<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 AdvisoryKey, ttl: Duration, deadline: Duration, ) -> Pin<Box<dyn Future<Output = PersistenceResult<LockGuard>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Block until the lock is acquired or deadline elapses. Implementors poll with backoff between attempts.

fn extend<'life0, 'life1, 'async_trait>( &'life0 self, _guard: &'life1 LockGuard, _ttl: Duration, ) -> Pin<Box<dyn Future<Output = PersistenceResult<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Extend the holder’s TTL. Returns Ok(false) when the lock has already been released or expired (the guard’s token no longer matches the stored value).

fn release<'life0, 'async_trait>( &'life0 self, guard: LockGuard, ) -> Pin<Box<dyn Future<Output = PersistenceResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Release the lock. Consumes the guard. The implementation is a no-op when the token already mismatches (lock expired by TTL before the caller got here).