Struct nafcodec::EncoderBuilder

pub struct EncoderBuilder { /* private fields */ }

A builder to configure and initialize an Encoder.

The fields to encode are opt-in: only the fields enabled through the builder will be extracted from the Record passed to Encoder::push and written to the archive.

For instance, to write a nucleotide archive containing only the sequence and identifier of each record:

let encoder = nafcodec::EncoderBuilder::new(nafcodec::SequenceType::Dna)
    .id(true)
    .sequence(true)
    .with_memory()
    .unwrap();

Implementations

impl EncoderBuilder

pub fn new(sequence_type: SequenceType) -> Self

Create a new encoder builder with default parameters.

pub fn from_flags<F: Into<Flags>>(sequence_type: SequenceType, flags: F) -> Self

Create a new encoder builder from the given flags.

This constructor can be used as a shortcut to setup encoding of a subset of supported fields. For instance, to write only the sequence identifiers and quality lines to an archive:

let mut encoder = EncoderBuilder::from_flags(Dna, Flag::Id | Flag::Quality)
    .with_memory()
    .unwrap();

pub fn id(&mut self, id: bool) -> &mut Self

Whether or not to encode the identifier of each record.

pub fn comment(&mut self, comment: bool) -> &mut Self

Whether or not to encode the comment of each record.

pub fn sequence(&mut self, sequence: bool) -> &mut Self

Whether or not to encode the sequence of each record.

pub fn quality(&mut self, quality: bool) -> &mut Self

Whether or not to decode the quality of each record.

pub fn compression_level(&mut self, level: i32) -> &mut Self

The compression level to use for zstd compression.

Pass 0 to use the default zstd value, otherwise any integer in range 1-22. See zstd::stream::write::Encoder for more information.

pub fn with_memory<'z>(&self) -> Result<Encoder<'z, Memory>, Error>

Consume the builder to get an encoder using in-memory storage.

pub fn with_storage<'z, S: Storage>( &self, storage: S ) -> Result<Encoder<'z, S>, Error>

Consume the builder to get an encoder using the given storage.

Trait Implementations

impl Clone for EncoderBuilder

fn clone(&self) -> EncoderBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncoderBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.