Struct rust_htslib::bam::Reader

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

A BAM reader.

Fields

header: HeaderView

Methods

impl Reader

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

Create a new Reader.

Arguments

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

Trait Implementations

impl Send for Reader

impl Read for Reader

fn read(&self, record: &mut Record) -> Result<(), ReadError>

Read next BAM record into given record. Use this method in combination with a single allocated record to avoid the reallocations occurring with the iterator.

fn records(&self) -> Records<Self>

Iterator over the records of the seeked region. Note that, while being convenient, this is less efficient than pre-allocating a Record and reading into it with the read method, since every iteration involves the allocation of a new Record.

fn pileup(&self) -> Pileups

Iterator over pileups.

fn bgzf(&self) -> *mut Struct_BGZF

Return the BGZF struct

impl Drop for Reader

fn drop(&mut self)

A method called when the value goes out of scope.