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 or other text-delimited tabular file formats including TSV (tab-separated values).

Note that encoding Metadata in CSV is not supported.

Implementations

impl<W> Encoder<W>

where W: Write,

pub fn builder(writer: W) -> EncoderBuilder<W>

Creates a builder for configuring an Encoder object.

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.

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

pub fn encode_header<R: DbnEncodable>( &mut self, with_symbol: bool ) -> Result<()>

Encodes the CSV header for the record type R, i.e. the names of each of the fields to the output.

If with_symbol is true, will add a header field for “symbol”. This should only be used with Self::encode_record_with_sym() and Self::encode_ref_with_sym(), otherwise there will be a mismatch between the number of fields in the header and the body.

Errors

This function returns an error if there’s an error writing to writer.

pub fn encode_header_for_schema( &mut self, schema: Schema, ts_out: bool, with_symbol: bool ) -> Result<()>

Encodes the CSV header for schema, i.e. the names of each of the fields to the output.

If ts_out is true, it will add a header field “ts_out”.

If with_symbol is true, it will add a header field for “symbol”. This should only be used with Self::encode_record_with_sym() and Self::encode_ref_with_sym(), otherwise there will be a mismatch between the number of fields in the header and the body.

Errors

This function returns an error if there’s an error writing to writer.

Trait Implementations

impl<W> EncodeDbn for Encoder<W>

where W: Write,

fn encode_stream<R: DbnEncodable>( &mut self, stream: impl FallibleStreamingIterator<Item = R, Error = Error> ) -> 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: DecodeRecordRef + DbnMetadata>( &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_records<R: DbnEncodable>(&mut self, records: &[R]) -> Result<()>

Encodes a slice of DBN records.

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

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

impl<W> EncodeRecord for Encoder<W>

where W: Write,

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

Encodes a single DBN record of type R.

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

Flushes any buffered content to the true output.

impl<W> EncodeRecordRef for Encoder<W>

where W: Write,

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

Encodes a single DBN RecordRef.

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

Encodes a single DBN RecordRef with an optional ts_out (see record::WithTsOut).

impl<W> EncodeRecordTextExt for Encoder<W>

where W: Write,

fn encode_record_with_sym<R: DbnEncodable>( &mut self, record: &R, symbol: Option<&str> ) -> Result<()>

Encodes a single DBN record of type R along with the record’s text symbol.

fn encode_ref_with_sym( &mut self, record: RecordRef<'_>, symbol: Option<&str> ) -> Result<()>

Encodes a single DBN RecordRef along with the record’s text symbol.

unsafe fn encode_ref_ts_out_with_sym( &mut self, record: RecordRef<'_>, ts_out: bool, symbol: Option<&str> ) -> Result<()>

Encodes a single DBN RecordRef with an optional ts_out (see record::WithTsOut) along with the record’s text symbol.