Struct nafcodec::Encoder

pub struct Encoder<'z, S: Storage> { /* private fields */ }

An encoder for Nucleotide Archive Format files.

NAF archives decomposes data into separate content blocks, which means a NAF file can only be written to a file once all the records have been processed. The encoder uses a temporary storage to store the intermediate data, with an abstract interface declared as the Storage trait.

Implementations

impl<S: Storage> Encoder<'_, S>

pub fn push(&mut self, record: &Record) -> Result<(), Error>

Push a Record to the archive.

The records contents are written to the temporary storage used internally by the Encoder, but the Encoder::write method needs to be called once all records have been added to build the final archive.

pub fn write<W: Write>(self, file: W) -> Result<(), Error>

Finalize the archive and write it to the given writer.

This method consumes the Encoder, since it cannot receive any additional Record after the compressed blocks have been finalized.