Enum CheckpointStreamItem 

pub enum CheckpointStreamItem {
    Checkpoint(Box<CheckpointResponse>),
    Progress {
        latest_scanned_sequence_number: CheckpointSequenceNumber,
    },
}

An item from a checkpoint data stream.

When filter_checkpoints is enabled, the server may skip checkpoints that don’t match the provided filters. In that case, Progress items are sent periodically to indicate liveness and the current scan position. When filter_checkpoints is disabled, only Checkpoint items are produced.

For liveness detection with filter_checkpoints, wrap stream.next() in tokio::time::timeout() — if neither a Checkpoint nor a Progress arrives within your chosen duration plus some buffer for connection latency, the connection is likely dead.

Variants

Checkpoint(Box<CheckpointResponse>)

A complete checkpoint with its transactions and events.

Progress

A progress indicator sent during filtered scanning. Contains the sequence number of the latest scanned checkpoint.

Fields

latest_scanned_sequence_number: CheckpointSequenceNumber

Implementations

impl CheckpointStreamItem

pub fn into_checkpoint(self) -> Option<CheckpointResponse>

Returns the contained checkpoint, or None if this is a progress message.

pub fn into_progress(self) -> Option<CheckpointSequenceNumber>

Returns the progress sequence number, or None if this is a checkpoint.

pub fn is_checkpoint(&self) -> bool

Returns true if this is a checkpoint item.

pub fn is_progress(&self) -> bool

Returns true if this is a progress item.

Trait Implementations

impl Clone for CheckpointStreamItem

fn clone(&self) -> CheckpointStreamItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointStreamItem

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

Formats the value using the given formatter.