Struct ReadPlanBuilder

Source
pub(crate) struct ReadPlanBuilder {
    batch_size: usize,
    selection: Option<RowSelection>,
}
Expand description

A builder for ReadPlan

Fields§

§batch_size: usize§selection: Option<RowSelection>

Current to apply, includes all filters

Implementations§

Source§

impl ReadPlanBuilder

Source

pub(crate) fn new(batch_size: usize) -> Self

Create a ReadPlanBuilder with the given batch size

Source

pub(crate) fn with_selection(self, selection: Option<RowSelection>) -> Self

Set the current selection to the given value

Source

pub(crate) fn selection(&self) -> Option<&RowSelection>

Returns the current selection, if any

Source

pub(crate) fn limited(self, row_count: usize) -> LimitedReadPlanBuilder

Specifies the number of rows in the row group, before filtering is applied.

Returns a LimitedReadPlanBuilder that can apply offset and limit.

Call LimitedReadPlanBuilder::build_limited to apply the limits to this selection.

Source

pub(crate) fn selects_any(&self) -> bool

Returns true if the current plan selects any rows

Source

pub(crate) fn num_rows_selected(&self) -> Option<usize>

Returns the number of rows selected, or None if all rows are selected.

Source

pub(crate) fn with_predicate( self, array_reader: Box<dyn ArrayReader>, predicate: &mut dyn ArrowPredicate, ) -> Result<Self>

Evaluates an ArrowPredicate, updating this plan’s selection

If the current selection is Some, the resulting RowSelection will be the conjunction of the existing selection and the rows selected by predicate.

Note: pre-existing selections may come from evaluating a previous predicate or if the ParquetRecordBatchReader specified an explicit RowSelection in addition to one or more predicates.

Source

pub(crate) fn build(self) -> ReadPlan

Create a final ReadPlan the read plan for the scan

Trait Implementations§

Source§

impl Clone for ReadPlanBuilder

Source§

fn clone(&self) -> ReadPlanBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<T> ErasedDestructor for T
where T: 'static,