pub struct ParquetBarScan { /* private fields */ }Expand description
An immutable description of bounded bar partitions.
Implementations§
Source§impl ParquetBarScan
impl ParquetBarScan
Sourcepub fn describe(
root: impl AsRef<Path>,
exchange: &str,
symbol: &str,
timeframe: &str,
bounds: ParquetScanBounds,
) -> Result<Self>
pub fn describe( root: impl AsRef<Path>, exchange: &str, symbol: &str, timeframe: &str, bounds: ParquetScanBounds, ) -> Result<Self>
Describe bar partitions and bind each path to its current file fingerprint.
Sourcepub fn describe_cancellable<F>(
root: impl AsRef<Path>,
exchange: &str,
symbol: &str,
timeframe: &str,
bounds: ParquetScanBounds,
is_cancelled: F,
) -> Result<Self>
pub fn describe_cancellable<F>( root: impl AsRef<Path>, exchange: &str, symbol: &str, timeframe: &str, bounds: ParquetScanBounds, is_cancelled: F, ) -> Result<Self>
Describe bar partitions with cooperative cancellation.
Sourcepub fn cursor(&self) -> Result<ParquetBarCursor>
pub fn cursor(&self) -> Result<ParquetBarCursor>
Open a cursor against the file generations bound by this description.
Sourcepub fn cursor_with_read_size(
&self,
rows_per_read: usize,
) -> Result<ParquetBarCursor>
pub fn cursor_with_read_size( &self, rows_per_read: usize, ) -> Result<ParquetBarCursor>
Open a cursor with a maximum number of rows decoded per read.
Sourcepub fn latest_valid_bar_cancellable<F>(
&self,
is_cancelled: F,
) -> Result<Option<ParquetScannedRow<Bar>>>
pub fn latest_valid_bar_cancellable<F>( &self, is_cancelled: F, ) -> Result<Option<ParquetScannedRow<Bar>>>
Find the latest bar with a valid close inside the inclusive scan bounds.
Trait Implementations§
Source§impl Clone for ParquetBarScan
impl Clone for ParquetBarScan
Source§fn clone(&self) -> ParquetBarScan
fn clone(&self) -> ParquetBarScan
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for ParquetBarScan
impl RefUnwindSafe for ParquetBarScan
impl Send for ParquetBarScan
impl Sync for ParquetBarScan
impl Unpin for ParquetBarScan
impl UnsafeUnpin for ParquetBarScan
impl UnwindSafe for ParquetBarScan
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 more