Struct CandleReader 

pub struct CandleReader<R: Read> { /* private fields */ }

Streaming OHLCV CSV reader.

Implementations

impl CandleReader<BomStripReader<File>>

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a CSV file at path.

The first line must be a header row naming the OHLCV columns; a leading UTF-8 BOM and whitespace around values are tolerated.

Errors

Returns Error::Io if the file cannot be opened and Error::Malformed if the header does not contain every required column (timestamp,open,high,low,close,volume).

impl<R: Read> CandleReader<BomStripReader<R>>

pub fn from_reader(inner: R) -> Result<Self>

Build a reader from any std::io::Read source.

A leading UTF-8 BOM is stripped and the header is validated.

Errors

Returns Error::Malformed if the header does not contain every required column.

impl<R: Read> CandleReader<R>

pub fn from_csv_reader(reader: Reader<R>) -> Result<Self>

Wrap a pre-built csv::Reader; useful for testing or for non-default reader configuration.

Unlike from_reader this does not strip a BOM — the caller owns the reader’s configuration — but the header is still validated.

Errors

Returns Error::Malformed if the header does not contain every required column.

pub fn candles(&mut self) -> impl Iterator<Item = Result<Candle>> + '_

Iterator over decoded candles.

pub fn read_all(&mut self) -> Result<Vec<Candle>>

Read the entire stream into a Vec<Candle>. Convenient for backtests.

Trait Implementations

impl<R: Debug + Read> Debug for CandleReader<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.