Enum ScanTerminal 

pub enum ScanTerminal {
    ScanLimit {
        watermark: Watermark,
    },
    NaturalRange {
        end: NaturalRangeEnd,
        position: Position,
        claimed_checkpoint: Option<u64>,
    },
    CursorBound {
        position: Position,
        kind: CursorKind,
    },
    ServingFloor {
        position: Position,
        floor_checkpoint: u64,
    },
}

Variants

ScanLimit

Scan budget exhausted. Owns the mandatory authoritative frontier watermark (its cursor is always set by the frontier constructors).

Fields

watermark: Watermark

NaturalRange

The resolved interval is naturally exhausted at position.

Fields

end: NaturalRangeEnd

position: Position

claimed_checkpoint: Option<u64>

The checkpoint this page’s natural end reports as fully covered in Watermark.checkpoint, or None when nothing remains to claim: the window has no checkpoint, or an ascending scan ends at genesis. See ResolvedScan::natural_end_claim.

CursorBound

The caller-provided cursor bound truncates the interval at position.

Fields

position: Position

kind: CursorKind

ServingFloor

A descending scan with no lower bound of its own reached this server’s serving floor at position; everything below is pruned. It never renders as a QueryEnd: below the item limit, the stream sends a payload-free frame with Self::into_watermark and no end, then fails with the error Self::reason returns for it.

Fields

position: Position

floor_checkpoint: u64

Implementations

impl ScanTerminal

pub fn from_range_exhaustion( exhaustion: RangeExhaustion, position: Position, claimed_checkpoint: Option<u64>, ) -> Self

pub fn reason(&self) -> Result<QueryEndReason, RpcError>

The QueryEnd reason this terminal ends its page with. Self::ServingFloor ends its page with no QueryEnd, so for it this is the OutOfRange error its stream fails with instead, after the terminal watermark frame.

pub fn into_watermark(self, covered_checkpoint_bound: Option<u64>) -> Watermark

Render the trailing terminal frame’s watermark. Natural completion (LedgerTip/CheckpointBound) claims its claimed_checkpoint and ignores covered_checkpoint_bound (the range claim is always at least as strong). A cursor bound never claims its own checkpoint: its claim is exactly the accumulated item coverage. A serving floor claims the floor checkpoint behind a boundary cursor at the floor.

Trait Implementations

impl Clone for ScanTerminal

fn clone(&self) -> ScanTerminal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanTerminal

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

Formats the value using the given formatter.

impl PartialEq for ScanTerminal

fn eq(&self, other: &ScanTerminal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScanTerminal