Struct rust_htslib::bam::Writer

pub struct Writer { /* fields omitted */ }

A BAM writer.

Methods

impl Writer

pub fn from_path<P: AsRef<Path>>(
    path: P,
    header: &Header
) -> Result<Self, WriterPathError>

Create a new BAM file.

Arguments

• path - the path.
• header - header definition to use

pub fn from_cram_path<P: AsRef<Path>>(
    path: P,
    header: &Header
) -> Result<Self, WriterPathError>

Create a new CRAM file.

Arguments

• path - the path.
• header - header definition to use

pub fn from_stdout(header: &Header) -> Result<Self, BGZFError>

Create a new BAM file at STDOUT.

Arguments

• header - header definition to use

pub fn set_threads(&mut self, n_threads: usize) -> Result<(), ThreadingError>

Activate multi-threaded BAM write support in htslib. This should permit faster writing of large BAM files.

Arguments

• n_threads - number of extra background writer threads to use, must be > 0.

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

Write record to BAM.

Arguments

• record - the record to write

pub fn header(&self) -> &HeaderView

Return the header.

pub fn set_reference<P: AsRef<Path>>(
    &mut self,
    path: P
) -> Result<(), ReferencePathError>

Set the reference path for reading CRAM files.

Arguments

• path - path to the FASTA reference

Trait Implementations

impl Drop for Writer

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Writer

impl Debug for Writer

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.