Struct bam::bam_writer::BamWriterBuilder

pub struct BamWriterBuilder { /* fields omitted */ }

Builder of the BamWriter.

Implementations

impl BamWriterBuilder

pub fn new() -> Self

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

The option to write or skip header when creating the BAM writer (writing by default).

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

Specify compression level from 0 to 9 (6 by default).

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 from_path<P: AsRef<Path>>(
    &mut self,
    path: P,
    header: Header
) -> Result<BamWriter<File>>

Creates a BAM writer from a file and a header.

pub fn from_stream<W: Write>(
    &mut self,
    stream: W,
    header: Header
) -> Result<BamWriter<W>>

Creates a BAM writer from a stream and a header.