Struct ScanStreamOptions 

pub struct ScanStreamOptions<P = MemPager>
where
    P: Pager<Blob = EntryHandle> + Send + Sync,
{
    pub include_nulls: bool,
    pub order: Option<ScanOrderSpec>,
    pub row_id_filter: Option<Arc<dyn RowIdFilter<P>>>,
}

Options for configuring table scans.

These options control how rows are filtered, ordered, and materialized during scan operations.

Fields

include_nulls: bool

Whether to include rows where all projected columns are null.

When false (default), rows with all-null projections are dropped before batches are yielded. This is useful for sparse data where many rows may not have values for the selected columns.

order: Option<ScanOrderSpec>

Optional ordering to apply to results.

If specified, row IDs are sorted according to this specification before data is gathered into batches.

row_id_filter: Option<Arc<dyn RowIdFilter<P>>>

Optional filter for row-level visibility (e.g., MVCC).

Applied after column-level predicates but before data is materialized. Used to enforce transaction isolation.

Trait Implementations

impl<P> Clone for ScanStreamOptions<P>

where P: Pager<Blob = EntryHandle> + Send + Sync,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for ScanStreamOptions<P>

where P: Pager<Blob = EntryHandle> + Send + Sync,

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

Formats the value using the given formatter.

impl<P> Default for ScanStreamOptions<P>

where P: Pager<Blob = EntryHandle> + Send + Sync,

fn default() -> Self

Returns the “default value” for a type.