Struct bam::sam::SamWriterBuilder

pub struct SamWriterBuilder { /* fields omitted */ }

Builder of the SamWriter.

Implementations

impl SamWriterBuilder

pub fn new() -> Self

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

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

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

Creates a SAM writer from a file and a header.

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

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