Skip to main content

Module query_options

Module query_options 

Source

Structs§

IntraTxCoordinate
Intra-transaction coordinate: a transaction and an index within it (events today; any per-transaction-indexed lane). Boundary cursors may point at slots with no item.
LedgerWindow
A request’s window in ledger coordinates, for placing the resume point of a scan’s terminal frame, and the public position of its cursor, where the window names it (see ResolvedScan::end_resume_position and ResolvedScan::end_cursor_public_position).
QueryOptions
Validated, normalized form of QueryOptions (the proto wire type).
ResolvedCheckpointRange
A request’s checkpoint window resolved into the checkpoint-sequence interval to scan. Cursors do not narrow it: ResolvedScan::resolve applies them by scan position. Unlike ResolvedScan<u64>/ResolvedScan<IntraTxCoordinate>, the scan domain here is checkpoint space, so the entry and terminal checkpoints derive from range directly and need no extra fields.
ResolvedScan
A request’s checkpoint bounds resolved into the scan-position interval to scan, along with the checkpoint-space facts for watermark rendering.
ScanBounds
Semantic scan bounds over explicit scan positions (cursor trims need exclusive bounds on either side).
ScanWindow
A request’s checkpoint window in a lane’s scan-position space, narrowed to the request’s start and end positions inside the window’s edge checkpoints (see CheckpointPositions).

Enums§

Ordering
RangeExhaustion
Why a resolved scan interval is exhausted. Fixed at range-resolution time, carried through scan state, and rendered by ScanTerminal.

Traits§

ScanCursor
How a lane reads wire cursors: the token’s coordinate in the lane’s position space.
ScanPosition
A scan position with a successor, so scan bounds can tell exactly whether they admit any position.

Functions§

below_oldest_retained_version
The error for a request that needs versions of an object (a package, for one) below oldest_retained_version, the oldest one this server keeps: the object’s version at the end of floor_checkpoint, the lowest checkpoint whose object state it keeps. Older versions are pruned and permanently gone. It is below_serving_floor for floor_checkpoint, with the version as lowestAvailableVersion too, so a client can list from it instead.
below_serving_floor
The error for a request that needs data below this server’s serving floor, whose lowest available checkpoint is floor_checkpoint: that data is pruned and permanently gone. It is OutOfRange with a BELOW_EARLIEST_AVAILABLE ErrorInfo whose lowestAvailableCheckpoint is floor_checkpoint; retrying it on this server fails the same way.
validate_checkpoint_bounds
The requested checkpoint window’s validity check, standalone so backends can sequence it independently of options parsing (kv validates bounds before the read mask and options; the fused resolution re-runs it harmlessly).

Type Aliases§

IntraTxScanBounds