Struct utimeseries::TimeseriesWriter

pub struct TimeseriesWriter<T, W> { /* fields omitted */ }

Wraps a writer and writes blocks to it.

Methods

impl<T: Sized + Copy, W: Write> TimeseriesWriter<T, W>

pub fn create(
    out: W,
    block_length: u32,
    start: SystemTime,
    interval: Duration
) -> Result<Self, Error>

Creates a new TimeseriesWriter and writes the file header.

Each block contains a header with a timestamp, and block_length records of type T.

pub fn create_with_ns(
    out: W,
    block_length: u32,
    start: SystemTime,
    interval_ns: u64
) -> Result<Self, Error>

Creates a new TimeseriesWriter and writes the file header.

Each block contains a header with a timestamp, and block_length records of type T. The interval is given in nanoseconds.

pub fn record_values(
    &mut self,
    offset: Duration,
    values: &[T]
) -> Result<(), Error>

Writes a new block; values must have exactly block_length entries.

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

pub fn get_mut(&mut self) -> &mut W

Gets a mutable reference to the underlying writer.

pub fn start_time(&self) -> SystemTime

The start time of the time series.

pub fn interval(&self) -> Duration

The interval of the time series.

impl<T: Sized + Copy, W: Write + Seek + Read> TimeseriesWriter<T, W>

pub fn append(out: W) -> Result<Self, Error>

Creates a new TimeseriesWriter that appends to the given writer.

It reads the header from the beginning and then skips to the position after the last complete block. Additional blocks will be appended from there.

pub fn set_start_time(&mut self, start: SystemTime) -> Result<SystemTime, Error>

Updates the timeseries' start time, without changing any deltas. Returns the previous start time.

WARNING The underlying file must be opened in write mode. If it is in append mode, it will append garbage data to the end of the stream!

Trait Implementations

impl<T: Debug, W: Debug> Debug for TimeseriesWriter<T, W>

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

Formats the value using the given formatter.