Struct PgAdvisoryLock 

pub struct PgAdvisoryLock { /* private fields */ }

A PostgreSQL advisory lock identifier.

Advisory locks are application-level locks that don’t lock any table or row. They are useful for coordinating access to external resources.

Example

use sentinel_driver::advisory_lock::PgAdvisoryLock;

let lock = PgAdvisoryLock::new(12345);
let guard = lock.acquire(conn).await?;
// ... do work under lock ...
guard.release(conn).await?;

Implementations

impl PgAdvisoryLock

pub fn new(key: i64) -> Self

Create an advisory lock from a numeric key.

pub fn from_name(name: &str) -> Self

Create an advisory lock from a string key.

The string is hashed to produce a stable i64 key using the default hasher.

pub fn key(&self) -> i64

The numeric key for this lock.

pub async fn acquire( &self, conn: &mut Connection, ) -> Result<PgAdvisoryLockGuard>

Acquire this advisory lock (session-scoped, blocks until acquired).

pub async fn try_acquire( &self, conn: &mut Connection, ) -> Result<Option<PgAdvisoryLockGuard>>

Try to acquire this advisory lock without blocking.

Returns None if the lock is already held by another session.

Trait Implementations

impl Clone for PgAdvisoryLock

fn clone(&self) -> PgAdvisoryLock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgAdvisoryLock

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

Formats the value using the given formatter.

impl Copy for PgAdvisoryLock