Skip to main content

Module peek_scan

Module peek_scan 

Source
Expand description

An index peek’s walk over the two traces that answer it, as one suspendable object.

A PeekScan owns both cursors, the rows it has accumulated, and the accounting that bounds them, and it spends a single budget across both phases. It performs no IO and never awaits, so the same scan runs wherever its driver puts it, and a driver that stops it between two cursor positions picks it up again without repeating work.

Structs§

PeekScan 🔒
An index peek’s walk over its error trace and its ok trace.
StashBounds 🔒
How a scan’s rows may leave for the peek stash.
WalkPhases 🔒
What a walk has spent, in the phases the peek metrics report.

Enums§

ErrorPhase 🔒
The state of a PeekScan’s walk over its error trace.
ScanOutcome 🔒
The outcome of a fueled PeekScan::step.

Constants§

COUNT_BYTE_SIZE 🔒
The byte size of a row’s count, as an answer built from a RowBatch stores it.
OFFSET_BYTE_SIZE 🔒
The byte size of a row’s offset into the answer’s packed row data.

Functions§

entry_byte_len 🔒
The bytes one (row, count) entry contributes to the answer it ends up in.
rows_response 🔒
Builds the peek’s answer out of the rows a completed walk produced, sorted by order_by.

Type Aliases§

IndexPeekScan 🔒
The scan an index peek builds, over the ok trace of the arrangement that answers it.
RowBatch 🔒
Rows a scan hands to its driver, in the order the scan produced them.