Struct dbn::encode::json::Encoder

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

Type for encoding files and streams of DBN records in newline-delimited JSON (ndjson).

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 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_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 encode_stream<R: DbnEncodable>( &mut self, stream: impl StreamingIterator<Item = R> ) -> Result<()>

Encodes a stream of DBN records.

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

Flushes any buffered content to the true output.

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

Encodes a single DBN record.

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

Encodes DBN records directly from a DBN decoder.

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.