Struct ScanBuilder

Source
pub struct ScanBuilder { /* private fields */ }
Expand description

A struct for building a scan operation.

Implementations§

Source§

impl ScanBuilder

Source

pub fn new(layout_reader: Arc<dyn LayoutReader>) -> ScanBuilder

Source

pub fn with_filter(self, filter: Arc<dyn VortexExpr>) -> ScanBuilder

Source

pub fn with_some_filter( self, filter: Option<Arc<dyn VortexExpr>>, ) -> ScanBuilder

Source

pub fn with_projection(self, projection: Arc<dyn VortexExpr>) -> ScanBuilder

Source

pub fn with_row_range(self, row_range: Range<u64>) -> ScanBuilder

Source

pub fn with_some_row_range(self, row_range: Option<Range<u64>>) -> ScanBuilder

Source

pub fn with_selection(self, selection: Selection) -> ScanBuilder

Source

pub fn with_row_indices(self, row_indices: Buffer<u64>) -> ScanBuilder

Source

pub fn with_split_by(self, split_by: SplitBy) -> ScanBuilder

Source

pub fn with_canonicalize(self, canonicalize: bool) -> ScanBuilder

Set whether the scan should canonicalize the output.

Source

pub fn with_concurrency(self, concurrency: usize) -> ScanBuilder

The number of row splits to make progress on concurrently, must be greater than 0.

Source

pub fn with_metrics(self, metrics: VortexMetrics) -> ScanBuilder

Source

pub fn spawn_on<F, S>( self, spawner: S, ) -> Result<impl ArrayStream + 'static, VortexError>
where F: Future<Output = Result<Option<Arc<dyn Array>>, VortexError>>, S: FnMut(Pin<Box<dyn Future<Output = Result<Option<Arc<dyn Array>>, VortexError>> + Send>>) -> F + 'static,

Returns a stream over the scan with each CPU task spawned using the given spawn function.

Source

pub fn into_array_stream( self, ) -> Result<impl ArrayStream + 'static, VortexError>

Returns a stream over the scan with each CPU task polled on the current thread as per the behaviour of futures::stream::Buffered.

Source

pub fn into_array_iter( self, ) -> Result<impl ArrayIterator + 'static, VortexError>

Returns a blocking iterator over the scan.

All work will be performed on the current thread, with tasks interleaved per the configured concurrency.

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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

Source§

impl<T> ExprSerializable for T

Source§

impl<T> MaybeSendSync for T