Struct bam::bgzip::write::WriterBuilder

pub struct WriterBuilder { /* fields omitted */ }

Bgzip writer builder. Allows to specify compression level and the number of additional threads.

Implementations

impl WriterBuilder

pub fn new() -> Self

pub fn additional_threads(&mut self, additional_threads: u16) -> &mut Self

Specify the number of additional threads. Additional threads are used to compress blocks, while the main thread reads the writes to a file/stream. If additional_threads is 0 (default), the main thread will compress blocks itself.

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

Specify compression level from 0 to 9, where 0 represents no compression, and 9 represents maximal compression. The builder uses 6 as default.

pub fn from_path<P: AsRef<Path>>(&self, path: P) -> Result<Writer<File>>

Creates a writer from file.

pub fn from_stream<W: Write>(&self, stream: W) -> Writer<W>

Creates a writer from stream.