Struct SnapshotPager 

pub struct SnapshotPager { /* private fields */ }

A finite pager retaining one SQLite read transaction. The explicit marker makes accidental movement across unrelated executors a compile-time error.

use dovecote_sqlx_sqlite::SnapshotPager;

fn requires_send<T: Send>() {}

fn main() {
    requires_send::<SnapshotPager>();
}

Implementations

impl SnapshotPager

pub const fn cursor(&self) -> Option<RowId>

Returns the last row ID returned by a non-empty page.

pub const fn upper_bound(&self) -> Option<RowId>

Returns the maximum row ID visible to this pager.

pub const fn is_exhausted(&self) -> bool

Returns whether the pager has returned its final page.

pub async fn next_page( &mut self, limit: Limit, ) -> Result<Vec<PagedEvent>, PageError>

Reads the next bounded page from the retained snapshot.

Errors

Returns an error if a stored event or delivery cannot be validated or the database read fails. Roll back or drop the pager after a failed read.

pub async fn finish(self) -> Result<(), PageError>

Commits the read-only snapshot transaction and releases its connection.

Errors

Returns a database error if committing the read transaction fails. A lost commit response does not establish whether the server committed.

pub async fn rollback(self) -> Result<(), PageError>

Rolls back the snapshot transaction and releases its connection.

Errors

Returns a database error if rolling back the read transaction fails.

pub async fn close(self) -> Result<(), PageError>

Closes the pager by rolling back its transaction.

Errors

Returns a database error if rolling back the read transaction fails.