Struct Outbox 

pub struct Outbox;

Stateless facade for the durable outbox table.

Implementations

impl Outbox

pub async fn install() -> Result<(), Error>

Installs the portable outbox table and its delivery index.

Release migrations should normally own this DDL. This helper is useful for explicit application setup and tests; it never runs implicitly.

On MySQL/MariaDB the stream, event_key and claim_key columns use the binary ascii_bin collation, so keys compare case-sensitively as on PostgreSQL and SQLite. An existing table whose key columns still use another collation (created by an earlier version) is converted in place with ALTER TABLE, which rebuilds the table.

pub async fn enqueue( stream: impl Into<String>, event_key: impl Into<String>, event_kind: impl Into<String>, payload: &Value, ) -> Result<EnqueuedOutboxEvent, Error>

Enqueues an event inside the current Orm::transaction.

Refusing to open an implicit transaction prevents the domain mutation and its outbox row from accidentally committing independently.

pub async fn enqueue_with_tx( transaction: &mut Transaction<'_>, stream: impl Into<String>, event_key: impl Into<String>, event_kind: impl Into<String>, payload: &Value, ) -> Result<EnqueuedOutboxEvent, Error>

Enqueues through a caller-owned SQLx transaction.

pub async fn claim_next( stream: impl Into<String>, worker_id: impl Into<String>, lease_seconds: i64, max_attempts: i32, ) -> Result<Option<ClaimedOutboxEvent>, Error>

Claims one pending or lease-expired event for a stream.

pub async fn acknowledge( id: i64, claim_key: impl Into<String>, ) -> Result<bool, Error>

Marks an event delivered only when the exact claim token still owns it.

pub async fn fail( id: i64, claim_key: impl Into<String>, error: impl Into<String>, max_attempts: i32, retry_delay_seconds: i64, ) -> Result<bool, Error>

Releases an event for retry or dead-letters it at the attempt limit.