Struct Encoder 

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

Type for encoding files and streams of DBN records in JSON lines.

Implementations

impl<W> Encoder<W>

where W: Write,

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

Creates a new instance of Encoder. If should_pretty_print is true, each JSON object will be nicely formatted and indented, instead of the default compact output with no whitespace between key-value pairs.

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

Creates a builder for configuring an Encoder object.

pub fn encode_metadata(&mut self, metadata: &Metadata) -> Result<()>

Encodes metadata into JSON.

Errors

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

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

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

Returns a mutable reference to the underlying 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.

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

impl<W> EncodeRecordRef for Encoder<W>

where W: Write,

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

Encodes a single DBN RecordRef.

fn encode_record_refs(&mut self, records: &[RecordRef<'_>]) -> Result<()>

Encodes a slice of RecordRefs.

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.