Struct AsyncRecordEncoder 

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

Available on crate feature async only.

An async encoder of DBN records.

Implementations

impl<W> RecordEncoder<W>

where W: AsyncWriteExt + Unpin,

pub fn new(writer: W) -> Self

Creates a new instance of RecordEncoder that will forward its output to writer.

pub async fn encode<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 fn encode_ref(&mut self, record_ref: RecordRef<'_>) -> Result<()>

Encodes 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 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 fn into_inner(self) -> W

Consumes the encoder returning the original writer.

Trait Implementations

impl<W> AsyncEncodeRecord for RecordEncoder<W>

where W: AsyncWriteExt + Unpin,

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 RecordEncoder<W>

where W: AsyncWriteExt + Unpin,

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

Encodes a single DBN record.

Safety

DBN encoding a RecordRef is safe because no dispatching based on type is required.

Errors

This function will return an error if it fails to encode record to writer.

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

Encodes a single RecordRef.

impl<W> From<MetadataEncoder<W>> for RecordEncoder<W>

where W: AsyncWriteExt + Unpin,

fn from(meta_encoder: MetadataEncoder<W>) -> Self

Converts to this type from the input type.