Struct ParquetBarCursor 

pub struct ParquetBarCursor { /* private fields */ }

Partition-at-a-time cursor over ascending bar rows.

Implementations

impl ParquetBarCursor

pub fn open( root: impl AsRef<Path>, exchange: &str, symbol: &str, timeframe: &str, bounds: ParquetScanBounds, ) -> Result<Self>

Open a bar cursor directly from a Parquet data root.

pub fn open_with_read_size( root: impl AsRef<Path>, exchange: &str, symbol: &str, timeframe: &str, bounds: ParquetScanBounds, rows_per_read: usize, ) -> Result<Self>

Open a bar cursor with a maximum number of rows decoded per read.

pub fn open_cancellable<F>( root: impl AsRef<Path>, exchange: &str, symbol: &str, timeframe: &str, bounds: ParquetScanBounds, is_cancelled: F, ) -> Result<Self>

where F: FnMut() -> bool,

Open a bar cursor while checking cancellation during partition discovery.

pub fn open_cancellable_with_read_size<F>( root: impl AsRef<Path>, exchange: &str, symbol: &str, timeframe: &str, bounds: ParquetScanBounds, rows_per_read: usize, is_cancelled: F, ) -> Result<Self>

where F: FnMut() -> bool,

Open a bounded bar cursor with cancellable partition discovery.

pub fn next_bar(&mut self) -> Result<Option<Bar>>

Read the next ascending bar.

pub fn next_bar_with_ordinal( &mut self, ) -> Result<Option<ParquetScannedRow<Bar>>>

Read the next ascending bar with its physical source-row ordinal.

pub fn next_bar_cancellable<F>( &mut self, is_cancelled: F, ) -> Result<Option<Bar>>

where F: FnMut() -> bool,

Read the next ascending bar with cooperative cancellation.

pub fn next_bar_with_ordinal_cancellable<F>( &mut self, is_cancelled: F, ) -> Result<Option<ParquetScannedRow<Bar>>>

where F: FnMut() -> bool,

Read the next bar and source ordinal with cooperative cancellation.

pub fn remaining_partitions(&self) -> usize

Number of date partitions still active or pending.

pub fn rows_per_read(&self) -> usize

Maximum number of rows decoded by one Parquet read.