Struct StatsWriter 

pub struct StatsWriter<W: Write> { /* private fields */ }

Streams a stat time series to a writer as CSV.

Call push once per sampled tick, then finish. The first push writes the header, with the columns of its sample. A StatDescriptor does not say whether its value is a scalar, a vector or a histogram.

Implementations

impl<W: Write> StatsWriter<W>

pub fn new(out: W) -> Self

Returns a writer over out that has written nothing.

pub fn push( &mut self, tick: u64, stats: &[StatEntry], ) -> Result<(), StatsWriteError>

Writes the row of the sample stats, taken at tick.

The first call fixes the column layout and writes the header.

Errors

Returns StatsWriteError::Io when a write fails, and StatsWriteError::Shape when stats does not fit the layout the first sample fixed.

pub fn finish(self) -> Result<u64, StatsWriteError>

Flushes the writer and returns the number of rows written.

Note that a BufWriter dropped without a flush discards its write errors.

Errors

Returns StatsWriteError::Io when the flush fails.

pub fn into_inner(self) -> Result<(W, u64), StatsWriteError>

Flushes the writer and returns it with the number of rows written.

Errors

Returns StatsWriteError::Io when the flush fails.

pub fn rows(&self) -> u64

Number of rows written so far, not counting the header.

Trait Implementations

impl<W: Debug + Write> Debug for StatsWriter<W>

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

Formats the value using the given formatter.