Struct rust_htslib::bam::Reader

pub struct Reader { /* fields omitted */ }

A BAM reader.

Methods

impl Reader

fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, ReaderPathError>

Create a new Reader from path.

Arguments

• path - the path to open.

fn from_stdin() -> Result<Self, BGZFError>

Create a new Reader from STDIN.

fn from_url(url: &Url) -> Result<Self, BGZFError>

Create a new Reader from URL.

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 fetched 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

fn header(&self) -> &HeaderView

Return the header.

fn seek(&self, offset: i64) -> Result<(), SeekError>

fn tell(&self) -> i64

impl Drop for Reader

fn drop(&mut self)

A method called when the value goes out of scope.