Struct rust_htslib::bam::Writer

pub struct Writer {
    pub header: HeaderView,
    // some fields omitted
}

A BAM writer.

Fields

header: HeaderView

Methods

impl Writer

fn new<P: AsRef<Path>>(path: &P, header: &Header) -> Result<Self, BGZFError>

Create a new BAM file.

Arguments

• path - the path. Use "-" for stdin.
• header - header definition to use

fn with_template<P: AsRef<Path>, T: AsRef<Path>>(template: &T, path: &P) -> Result<Self, BGZFError>

Create a new BAM file from template.

Arguments

• path - the path. Use "-" for stdin.
• template - the template BAM. Use "-" for stdin.

fn write(&mut self, record: &Record) -> Result<(), WriteError>

Write record to BAM.

Arguments

• record - the record to write

Trait Implementations

impl Send for Writer

impl Drop for Writer

fn drop(&mut self)

A method called when the value goes out of scope.