Struct dbn::encode::DynEncoder

pub struct DynEncoder<'a, W>(/* private fields */)
where
    W: Write;

An encoder whose Encoding and Compression can be set at runtime.

Implementations

impl<'a, W> DynEncoder<'a, W>

where W: Write,

pub fn new( writer: W, encoding: Encoding, compression: Compression, metadata: &Metadata, should_pretty_print: bool, use_pretty_px: bool, use_pretty_ts: bool, ) -> Result<Self>

Constructs a new instance of DynEncoder.

Note: should_pretty_print, use_pretty_px, and use_pretty_ts are ignored if encoding is Dbn.

Errors

This function returns an error if it fails to encode the DBN metadata or it fails to initialize the Zstd compression.

pub fn builder( writer: W, encoding: Encoding, compression: Compression, metadata: &Metadata, ) -> DynEncoderBuilder<'_, W>

Creates a builder for configuring a DynEncoder object.

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”.

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, will add a header field “ts_out”. If with_symbol is true, will add a header field “symbol”.

Errors

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

Trait Implementations

impl<'a, W> EncodeDbn for DynEncoder<'a, W>

where W: Write,

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

Encodes a slice of DBN records.

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

Encodes a stream of DBN records.

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

Encodes DBN records directly from a DBN decoder.

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<'a, W> EncodeRecord for DynEncoder<'a, 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<'a, W> EncodeRecordRef for DynEncoder<'a, 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<'a, W> EncodeRecordTextExt for DynEncoder<'a, 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.