Struct WriterBuilder 

pub struct WriterBuilder { /* private fields */ }

Configuration for a FastxWriter.

use fastx::{Alphabet, WriterBuilder};

// Format and gzip are inferred from the path: this writes gzipped FASTQ.
let mut writer = WriterBuilder::new()
    .line_width(80)
    .validate(Alphabet::Dna)
    .create("out.fq.gz")?;
writer.finish()?;

Implementations

impl WriterBuilder

pub fn new() -> WriterBuilder

A builder with default settings.

pub fn format(self, format: Format) -> Self

Force the output format instead of inferring it from the path.

pub fn line_width(self, width: usize) -> Self

FASTA line width; 0 disables wrapping.

pub fn compression(self, compression: Compression) -> Self

Force compression instead of inferring it from the path.

pub fn level(self, level: CompressionLevel) -> Self

gzip compression level.

pub fn validate(self, alphabet: Alphabet) -> Self

Validate records against an alphabet before writing.

pub fn buffer_size(self, bytes: usize) -> Self

Output buffer size in bytes.

pub fn blocks_per_batch(self, blocks: usize) -> Self

How many BGZF blocks to compress at a time.

Only affects BGZF output. Blocks are independent, so a batch is compressed across cores and the bytes written are identical either way — this trades blocks × 64 KiB of memory for parallelism. The default is several blocks per core; pass 1 to force single-threaded compression.

pub fn build<W: Write>(&self, inner: W) -> Result<FastxWriter<W>>

Build a writer around any Write. Requires a format to be set.

pub fn create<P: AsRef<Path>>(&self, path: P) -> Result<BoxedWriter>

Create a file, inferring format and gzip compression from its extension.

pub fn stdout(&self) -> Result<BoxedWriter>

Write to standard output.

Trait Implementations

impl Clone for WriterBuilder

fn clone(&self) -> WriterBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriterBuilder

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

Formats the value using the given formatter.

impl Default for WriterBuilder

fn default() -> Self

Returns the “default value” for a type.