Struct SnapshotPager 

pub struct SnapshotPager { /* private fields */ }

A bounded, finite read over one PostgreSQL repeatable-read snapshot.

The pager owns the connection-bound transaction. It does not accept an arbitrary executor and never releases the transaction between pages. A pager is intentionally not a stream: callers choose explicit page bounds and must finish or roll back the read transaction.

The pager is deliberately not Send: the snapshot and its connection must stay with the executor that created them.

use dovecote_sqlx_postgres::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’s finite export.

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.

An empty page marks the pager exhausted and does not advance its cursor. Once exhausted, subsequent calls return an empty page without issuing SQL; call finish or rollback to release the transaction explicitly.

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

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

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

Rolls back the read-only transaction and releases its pooled connection.

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

Closes the pager by rolling back its read-only transaction.