Struct dbn::encode::csv::Encoder

pub struct Encoder<W>where
    W: Write,{ /* private fields */ }

Type for encoding files and streams of DBN records in CSV.

Note that encoding Metadata in CSV is not supported.

Implementations

impl<W> Encoder<W>where W: Write,

pub fn new(writer: W, use_pretty_px: bool, use_pretty_ts: bool) -> Self

Creates a new Encoder that will write to writer. If use_pretty_px is true, price fields will be serialized as a decimal. If pretty_ts is true, timestamp fields will be serialized in a ISO8601 datetime string.

Trait Implementations

impl<W> EncodeDbn for Encoder<W>where W: Write,

fn encode_stream<R: DbnEncodable>( &mut self, stream: impl StreamingIterator<Item = R> ) -> Result<()>

Encodes a stream of DBN records.

Errors

This function returns an error if it’s unable to write to the underlying writer or there’s a serialization error.

fn encode_decoded<D: DecodeDbn>(&mut self, decoder: D) -> Result<()>

Encode DBN records directly from a DBN decoder. This implemented outside EncodeDbn because the CSV encoder has the additional constraint of only being able to encode a single schema in a stream.

Errors

This function returns an error if it’s unable to write to the underlying writer or there’s a serialization error.

fn encode_record<R: DbnEncodable>(&mut self, record: &R) -> Result<bool>

Encodes a single DBN record of type R.

fn encode_records<R: DbnEncodable>(&mut self, records: &[R]) -> Result<()>

Encodes a slice of DBN records.

fn flush(&mut self) -> Result<()>

Flushes any buffered content to the true output.

fn encode_decoded_with_limit<D: DecodeDbn>( &mut self, decoder: D, limit: NonZeroU64 ) -> Result<()>

Encodes DBN records directly from a DBN decoder, outputting no more than limit records.

unsafe fn encode_record_ref( &mut self, record: RecordRef<'_>, ts_out: bool ) -> Result<bool>

Encodes a single DBN record.