Skip to main content

SqliteOutbox

Struct SqliteOutbox 

Source
pub struct SqliteOutbox { /* private fields */ }

Implementations§

Source§

impl SqliteOutbox

Source

pub async fn open(path: impl AsRef<Path>) -> Result<Self, String>

Source

pub fn pool(&self) -> &SqlitePool

Source

pub fn path(&self) -> &Path

Source

pub async fn create_snapshot( &self, destination: impl AsRef<Path>, ) -> Result<OutboxSnapshot, String>

Create an immutable SQLite backup at destination.

VACUUM INTO runs against a consistent SQLite snapshot and includes the WAL contents in the resulting file. The temporary file is synced before an atomic rename so a crash cannot publish a partial backup.

Source

pub fn verify_snapshot(snapshot: &OutboxSnapshot) -> Result<(), String>

Source

pub fn restore_snapshot( snapshot: &OutboxSnapshot, destination: impl AsRef<Path>, ) -> Result<(), String>

Restore a verified snapshot before opening the live database.

Source

pub async fn register_target(&self, target: &TargetId) -> Result<(), String>

Source

pub async fn create_index_generation( &self, target: &TargetId, index_id: u64, generation: u64, snapshot_lsn: CommitLsn, ) -> Result<(), String>

Source

pub async fn transition_generation_to_backfilling( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<(), String>

Source

pub async fn transition_generation_to_catching_up( &self, target: &TargetId, index_id: u64, generation: u64, barrier_lsn: CommitLsn, ) -> Result<(), String>

Source

pub async fn transition_generation_to_publishing( &self, target: &TargetId, index_id: u64, generation: u64, barrier_lsn: CommitLsn, ) -> Result<(), String>

Source

pub async fn activate_generation( &self, target: &TargetId, index_id: u64, generation: u64, barrier_lsn: CommitLsn, ) -> Result<(), String>

Source

pub async fn drain_generation( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<(), String>

Source

pub async fn drop_generation( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<(), String>

Source

pub async fn fail_generation( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<(), String>

Source

pub async fn get_generation_state( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<Option<(String, Option<CommitLsn>)>, String>

Source

pub async fn get_active_generation( &self, target: &TargetId, index_id: u64, ) -> Result<Option<u64>, String>

Source

pub async fn list_index_generations( &self, target: &TargetId, index_id: u64, ) -> Result<Vec<(u64, String)>, String>

List all known generations (with states) for one index. Used by the rebuild driver to detect and fail generations left behind by crashes.

Source

pub async fn fetch_rebuild_events( &self, target: &TargetId, index_id: u64, after_lsn: CommitLsn, upto_lsn: CommitLsn, limit: u64, ) -> Result<Vec<RebuildEvent>, String>

Fetch materialized events for catch-up replay in a commit-LSN range. Status-agnostic on purpose: retried, dead-lettered, or skipped events in the range are replayed idempotently so the rebuilt index converges even when the live delivery plane degraded mid-rebuild.

Source

pub async fn materialize_commit( &self, commit_lsn: CommitLsn, intents: &[OutboxIntent], targets: &[TargetId], ) -> Result<(), String>

Source

pub async fn claim_next( &self, target: &TargetId, owner: &str, now_ms: u64, lease_duration_ms: u64, ) -> Result<Option<ClaimedEvent>, String>

Source

pub async fn acknowledge(&self, event: &ClaimedEvent) -> Result<bool, String>

Source

pub async fn retry( &self, event: &ClaimedEvent, next_attempt_at_ms: u64, error: &str, ) -> Result<bool, String>

Source

pub async fn dead_letter( &self, event: &ClaimedEvent, failed_at_ms: u64, error: &str, ) -> Result<bool, String>

Source

pub async fn requeue_dead_letter(&self, event_id: i64) -> Result<bool, String>

Source

pub async fn requeue_dead_letters_batch( &self, target: Option<&TargetId>, index_id: Option<u64>, generation: Option<u64>, limit: usize, ) -> Result<usize, String>

Batch requeue dead letters filtered by target/index/generation. Returns number of events requeued.

Source

pub async fn list_dead_letters( &self, target: Option<&TargetId>, index_id: Option<u64>, generation: Option<u64>, limit: usize, offset: usize, ) -> Result<Vec<DeadLetterRow>, String>

Source

pub async fn list_degraded_ranges( &self, target: Option<&TargetId>, index_id: Option<u64>, generation: Option<u64>, ) -> Result<Vec<DegradedRangeRow>, String>

Source

pub async fn clear_degraded_range( &self, target: &TargetId, index_id: u64, generation: u64, start_lsn: CommitLsn, end_lsn: CommitLsn, ) -> Result<bool, String>

Source

pub async fn delivery_targets(&self) -> Result<Vec<TargetId>, String>

Source

pub async fn stats(&self) -> Result<OutboxStats, String>

Return aggregate delivery statistics from the durable projection.

The in-memory transaction staging map is intentionally not used here: once a commit has crossed the WAL and SQLite materialization fences, SQLite is the source of truth for backlog, leases, retries, and dead-letter state.

Source

pub async fn prune_applied_events( &self, retention_lsn: CommitLsn, ) -> Result<u64, String>

Source

pub async fn retention_lsn(&self) -> Result<CommitLsn, String>

Source

pub async fn update_retention_lsn( &self, retention_lsn: CommitLsn, ) -> Result<(), String>

Source

pub async fn archive_dead_letters( &self, retention_lsn: CommitLsn, ) -> Result<u64, String>

Archive dead letters older than retention_lsn into dead_letters_archive and remove from events.

Source

pub async fn prune_degraded_ranges( &self, max_age_ms: u64, ) -> Result<u64, String>

Prune degraded ranges older than max age.

Source

pub async fn compute_safe_retention_lsn( &self, grace_lsn_distance: u64, ) -> Result<CommitLsn, String>

Compute a safe retention LSN based on min applied frontier. Safe = min(target frontiers, index frontiers) - grace, at least 0.

Source

pub async fn retry_count(&self, event_id: i64) -> Result<u64, String>

Source

pub async fn materialized_lsn(&self) -> Result<CommitLsn, String>

Source

pub async fn target_frontier( &self, target: &TargetId, ) -> Result<CommitLsn, String>

Source

pub async fn index_frontier( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<CommitLsn, String>

Source

pub async fn wait_for_minimum_lsn( &self, target: &TargetId, index_id: u64, generation: u64, minimum_lsn: CommitLsn, timeout_ms: u64, ) -> Result<bool, String>

Source

pub async fn skip_event_degraded( &self, event: &ClaimedEvent, reason: &str, ) -> Result<bool, String>

Source

pub async fn has_degraded_range( &self, target: &TargetId, index_id: u64, generation: u64, ) -> Result<bool, String>

Source

pub async fn has_degraded_range_through( &self, target: &TargetId, index_id: u64, generation: u64, minimum_lsn: CommitLsn, ) -> Result<bool, String>

Source

pub async fn dead_lettered_count( &self, target: &TargetId, ) -> Result<u64, String>

Source

pub async fn diagnostics(&self) -> Result<SyncDiagnostics, String>

Return a single consistent view of outbox backlog, delivery frontiers, degraded ranges, and index-generation progress.

Trait Implementations§

Source§

impl Clone for SqliteOutbox

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SqliteOutbox

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more