pub struct PredicateOptions<'a> { /* private fields */ }Expand description
Options for ReadPlanBuilder::with_predicate_options.
Implementations§
Source§impl<'a> PredicateOptions<'a>
impl<'a> PredicateOptions<'a>
Sourcepub fn new(
array_reader: Box<dyn ArrayReader>,
predicate: &'a mut (dyn ArrowPredicate + 'static),
) -> PredicateOptions<'a>
pub fn new( array_reader: Box<dyn ArrayReader>, predicate: &'a mut (dyn ArrowPredicate + 'static), ) -> PredicateOptions<'a>
Create options for evaluating predicate against rows produced by
array_reader.
By default there is no match-count limit; the predicate is evaluated
over every row the reader yields. Use Self::with_limit to enable
early termination.
Sourcepub fn with_limit(self, limit: usize, total_rows: usize) -> PredicateOptions<'a>
pub fn with_limit(self, limit: usize, total_rows: usize) -> PredicateOptions<'a>
Stop scanning array_reader once limit matches have accumulated.
Performance optimization for LIMIT / TopK: when the cumulative
true_count reaches limit, the current filter batch is truncated
at the limit-th match and remaining batches are never decoded.
limit counts predicate matches, not output rows — callers applying
an offset must pass offset + limit.
total_rows is the row count array_reader would yield if iterated
to completion. It is used to pad un-evaluated trailing rows as “not
selected” so the returned RowSelection covers the full row group.
Only valid for the last predicate in a filter chain: intermediate predicates’ match counts do not map 1:1 to output rows.
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for PredicateOptions<'a>
impl<'a> !Sync for PredicateOptions<'a>
impl<'a> !UnwindSafe for PredicateOptions<'a>
impl<'a> Freeze for PredicateOptions<'a>
impl<'a> Send for PredicateOptions<'a>
impl<'a> Unpin for PredicateOptions<'a>
impl<'a> UnsafeUnpin for PredicateOptions<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more