Enum PgAdvisoryLockKey

#[non_exhaustive]
pub enum PgAdvisoryLockKey {
    BigInt(i64),
    IntPair(i32, i32),
}

Available on crate feature postgres only.

A key type natively used by Postgres advisory locks.

Currently, Postgres advisory locks have two different key spaces: one keyed by a single 64-bit integer, and one keyed by a pair of two 32-bit integers. The Postgres docs specify that these key spaces “do not overlap”:

https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS

The documentation for the pg_locks system view explains further how advisory locks are treated in Postgres:

https://www.postgresql.org/docs/current/view-pg-locks.html

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BigInt(i64)

The keyspace designated by a single 64-bit integer.

When PgAdvisoryLock is constructed with ::new(), this is the keyspace used.

IntPair(i32, i32)

The keyspace designated by two 32-bit integers.

Implementations

impl PgAdvisoryLockKey

pub fn as_bigint(&self) -> Option<i64>

Converts Self::Bigint(bigint) to Some(bigint) and all else to None.

Trait Implementations

impl Clone for PgAdvisoryLockKey

fn clone(&self) -> PgAdvisoryLockKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PgAdvisoryLockKey

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

Formats the value using the given formatter.

impl PartialEq for PgAdvisoryLockKey

fn eq(&self, other: &PgAdvisoryLockKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PgAdvisoryLockKey

impl StructuralPartialEq for PgAdvisoryLockKey