Struct Lock 

pub struct Lock;

The service’s own Lock: set by InboxSpec::own.

Examples

The service’s own lock comes with its own unlock, own::Unlock:

use ruststream_sqlx::dialect::{Column, KeyPart};
use ruststream_sqlx::spec::{Advisory, Payload, own};
use ruststream_sqlx::{InboxSpec, InboxTable, Lock};
use sqlx::{PgConnection, Postgres};

#[derive(sqlx::FromRow)]
pub struct Booking {
    id: i64,
    payload: Vec<u8>,
}

impl InboxTable for Booking {
    type Id = i64;
    type Table = InboxSpec<(Advisory, Payload, own::Lock, own::Unlock)>;
    const TABLE: Self::Table = InboxSpec::new("bookings", Column::new("id").generated())
        .advisory(&[KeyPart::Literal("room-"), KeyPart::Column("room")])
        .payload(Column::new("payload"))
        .own::<own::Lock>()
        .own::<own::Unlock>();

    fn id(&self) -> &i64 {
        &self.id
    }
}

// The front desk application locks a room as `(42, hashtext(key))`, so the queue takes that lock.
impl Lock<Postgres> for Booking {
    async fn lock(conn: &mut PgConnection, key: &str) -> Result<bool, sqlx::Error> {
        sqlx::query_scalar("SELECT pg_try_advisory_lock(42, hashtext($1))")
            .bind(key)
            .fetch_one(conn)
            .await
    }
}

Trait Implementations

impl Debug for Lock

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

Formats the value using the given formatter.

impl Declaration for Lock

type Form = Unset

The form: Lease or Advisory; unset for the row lock form.

type Message = Unset

The message mode: Payload; unset for row mode.

type Key = Unset

The partition key: Key.

type Attempt = Unset

The attempt count: Attempt.

type Headers = Unset

The delivery’s headers: Headers or HeaderFields.

type RetryAfter = Unset

The time a retried row is due: RetryAfter.

type ProcessedAt = Unset

The time a row was processed: ProcessedAt.

type Clock = Unset

The clock: Clock; unset for SystemClock.

type Opening = Unset

What the table’s transactions open at: Opens; unset for the database’s default.

type Fifo = Unset

Groups kept in order: Fifo.

type OwnClaim = Unset

The service’s own claim: own::Claim.

type OwnFetch = Unset

The service’s own fetch: own::Fetch.

type OwnAck = Unset

The service’s own ack: own::Ack.

type OwnRetry = Unset

The service’s own retry: own::Retry.

type OwnRetryAfter = Unset

The service’s own delayed retry: own::RetryAfter.

type OwnDiscard = Unset

The service’s own discard: own::Discard.

type OwnDeadLetter = Unset

The service’s own dead letter: own::DeadLetter.

type OwnExtend = Unset

The service’s own lease extension: own::Extend.

type OwnLock = Set<Lock>

The service’s own lock: own::Lock.

type OwnUnlock = Unset

The service’s own unlock: own::Unlock.

impl OwnEvent for Lock