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

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.

Trait Implementations

impl<W> AsyncEncodeRecord for Encoder<W>

where W: AsyncWriteExt + Unpin,

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

Encodes a slice of DBN records.

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.

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

Encodes a single DBN record of type R.

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

Flushes any buffered content to the true output.

async fn shutdown(&mut self) -> Result<()>

Initiates or attempts to shut down the inner writer.

impl<W> AsyncEncodeRecordRef for Encoder<W>

where W: AsyncWriteExt + Unpin,

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

Encodes a single RecordRef.

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

Encodes a slice of RecordRefs.

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

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

async fn encode_record_ref_with_ts_out( &mut self, record_ref: RecordRef<'_>, ts_out: u64, ) -> Result<()>

Encodes a single DBN RecordRef with an appended ts_out timestamp.

async fn encode_record_refs_with_ts_out( &mut self, record_refs: &[RecordRef<'_>], ts_out: u64, ) -> Result<()>

Encodes a slice of RecordRefs, each with the same appended ts_out timestamp.

impl<W> AsyncEncodeRecordTextExt for Encoder<W>

where W: AsyncWriteExt + Unpin,

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

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

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