Struct CodedTimeSeriesWriter

pub struct CodedTimeSeriesWriter { /* private fields */ }

Available on crate features std and miniz only.

Coded Time Series Sample File consists of 2 streams: a data stream and a time stream backed by a MultiStreamWriter

Data stream:

1. Convert f64 to u64 bit-for-bit
2. Run it through a irox_tools::codec::CodeDictionary to map the observed values into unique u32 codes
3. Group those codes into blocks of 4 using GroupCodingStream and then encode into Varint-GB using GroupVarintCodeEncoder
4. Deflate/GZ the resultant byte stream.

It is assumed that the data stream samples come from something approximating a A2D sensor with a fixed number of detection bits and as such, most of the data will be fairly similar, even if very noisy when it jumps around.

Time stream: 0. Convert the time value into a u64 (external)

1. Run it through a DeltaStream to encode the first value, and then output the N-1 difference
2. Run it through the same 2, 3, 4 processing as the data stream.

It is assumed that the time series will be periodically sampled and atomically increasing

Implementations

impl CodedTimeSeriesWriter

pub fn new<T: AsRef<Path>>(path: T) -> Result<Self, Error>

pub fn write_sample(&mut self, sample: &Sample64) -> Result<(), Error>

pub fn flush(&mut self) -> Result<(), Error>

pub fn written_stats(&self) -> Vec<String>

pub fn metadata<K: AsRef<str>, V: AsRef<str>>( &mut self, key: K, value: V, ) -> Result<(), Error>