Struct bam::bam_writer::BamWriterBuilder

pub struct BamWriterBuilder { /* fields omitted */ }

Builder of the BamWriter.

Methods

impl BamWriterBuilder

pub fn new() -> Self

pub fn header(&mut self, header: Header) -> &mut Self

Specifies BAM header.

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 (6 by default).

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

Creates a BAM writer from a file. If you want to use the same instance of BamWriterBuilder again, you need to specify header again.

Panics if the header was not specified.

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

Creates a BAM writer from stream. Preferably the stream should be wrapped in a buffer writer, such as BufWriter.

If you want to use the same instance of BamWriterBuilder again, you need to specify header again.

Panics if the header was not specified.