Struct AsyncEncoder

pub struct AsyncEncoder<W>
where
    W: AsyncWriteExt + Unpin,
{ /* private fields */ }

Available on crate feature async only.

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

Implementations

impl<W> Encoder<W>

where W: AsyncWriteExt + Unpin,

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

Cancel safety

This method is not cancellation safe. If this method is used in a tokio::select! statement and another branch completes first, then the metadata JSON may have been partially written, but future calls will begin writing the metadata JSON from the beginning.

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.

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

Encode a single DBN record of type R.

Errors

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

Cancel safety

This method is not cancellation safe. If this method is used in a tokio::select! statement and another branch completes first, then the record may have been partially written, but future calls will begin writing the encoded record from the beginning.

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

Encodes a single DBN record.

Safety

ts_out must be false if record does not have an appended `ts_out

Errors

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

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

Flushes any buffered content to the true output.

Errors

This function returns an error if it’s unable to flush the underlying writer.

pub async fn shutdown(self) -> Result<()>

Initiates or attempts to shut down the inner writer.

Errors

This function returns an error if the shut down did not complete successfully.