Struct FilterPredicate 

pub struct FilterPredicate {
    filter: BooleanArray,
    count: usize,
    strategy: IterationStrategy,
}

A filtering predicate that can be applied to an [Array]

Fields

filter: BooleanArray

count: usize

strategy: IterationStrategy

Precomputed strategy for iterating over the selected rows of this predicate

Implementations

impl FilterPredicate

pub fn filter(&self, values: &dyn Array) -> Result<ArrayRef, ArrowError>

Selects rows from values based on this FilterPredicate

pub fn filter_record_batch( &self, record_batch: &RecordBatch, ) -> Result<RecordBatch, ArrowError>

Returns a filtered [RecordBatch] containing only the rows that are selected by this FilterPredicate.

This is the equivalent of calling filter on each column of the [RecordBatch].

pub fn count(&self) -> usize

Number of rows being selected based on this FilterPredicate

pub(crate) fn selection(&self) -> FilterSelection<'_>

Return a FilterSelection for iterating over the rows selected by this FilterPredicate.

pub fn filter_nulls(&self, nulls: Option<&NullBuffer>) -> Option<NullBuffer>

Filters the given nulls buffer using this predicate.

Returns None when there is nothing to track in the output, either because the input nulls was None, the input had no nulls, or the filtered result has no nulls. Otherwise returns the filtered [NullBuffer] with its precomputed null count.

Trait Implementations

impl Debug for FilterPredicate

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

Formats the value using the given formatter.