pub struct ScanBuilder { /* private fields */ }
Expand description
A struct for building a scan operation.
Implementations§
Source§impl ScanBuilder
impl ScanBuilder
pub fn new(layout_reader: Arc<dyn LayoutReader>) -> ScanBuilder
pub fn with_filter(self, filter: Arc<dyn VortexExpr>) -> ScanBuilder
pub fn with_some_filter( self, filter: Option<Arc<dyn VortexExpr>>, ) -> ScanBuilder
pub fn with_projection(self, projection: Arc<dyn VortexExpr>) -> ScanBuilder
pub fn with_row_range(self, row_range: Range<u64>) -> ScanBuilder
pub fn with_some_row_range(self, row_range: Option<Range<u64>>) -> ScanBuilder
pub fn with_selection(self, selection: Selection) -> ScanBuilder
pub fn with_row_indices(self, row_indices: Buffer<u64>) -> ScanBuilder
pub fn with_split_by(self, split_by: SplitBy) -> ScanBuilder
Sourcepub fn with_canonicalize(self, canonicalize: bool) -> ScanBuilder
pub fn with_canonicalize(self, canonicalize: bool) -> ScanBuilder
Set whether the scan should canonicalize the output.
Sourcepub fn with_concurrency(self, concurrency: usize) -> ScanBuilder
pub fn with_concurrency(self, concurrency: usize) -> ScanBuilder
The number of row splits to make progress on concurrently, must be greater than 0.
pub fn with_metrics(self, metrics: VortexMetrics) -> ScanBuilder
Sourcepub fn spawn_on<F, S>(
self,
spawner: S,
) -> Result<impl ArrayStream + 'static, VortexError>
pub fn spawn_on<F, S>( self, spawner: S, ) -> Result<impl ArrayStream + 'static, VortexError>
Returns a stream over the scan with each CPU task spawned using the given spawn function.
Sourcepub fn into_array_stream(
self,
) -> Result<impl ArrayStream + 'static, VortexError>
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
.
Sourcepub fn into_array_iter(
self,
) -> Result<impl ArrayIterator + 'static, VortexError>
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§
impl !Freeze for ScanBuilder
impl !RefUnwindSafe for ScanBuilder
impl Send for ScanBuilder
impl Sync for ScanBuilder
impl Unpin for ScanBuilder
impl !UnwindSafe for ScanBuilder
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
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
Mutably borrows from an owned value. Read more
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>
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 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>
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 moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
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
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
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>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out
indicating that a T
is niched.