Enum ScanStop 

pub enum ScanStop {
    ScanLimit {
        scan_frontier: u64,
    },
    Cancelled,
    Fault(Error),
}

Terminal signal of a merged bitmap eval stream, raised on the error channel so the try_stream! pipeline short-circuits (a clean end-of-stream means “scanned the whole range”). The List handlers map each variant to a wire outcome with one exhaustive match.

Mental model: leaves raise positionless LeafStops; the evaluator turns them into a ScanStop that ALWAYS carries the resume frontier on ScanLimit; in-band Watermarked::Watermarks are only mid-scan progress beacons, never the resume channel.

Variants

ScanLimit

Budget exhausted: a graceful early stop. The handler ends the stream with QUERY_END_REASON_SCAN_LIMIT; the frontier is the resume cursor.

Fields

scan_frontier: u64

Merged floor position every term provably scanned to when the budget died — the exact value the stopping round’s progress beacon would have carried. It lives in the scanned index’s member-id domain (tx-seq for transaction/checkpoint indexes; encoded event-seq — see event_seq — for the event index). Consumers apply their existing domain conversion and resume arithmetic.

Cancelled

Cancelled → gRPC Cancelled status.

Fault(Error)

Backend/storage fault → gRPC Internal, error carried unchanged.

Trait Implementations

impl Debug for ScanStop

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

Formats the value using the given formatter.

impl Display for ScanStop

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

Formats the value using the given formatter.

impl Error for ScanStop

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ScanStop

fn from(err: Error) -> Self

Converts to this type from the input type.