Struct rust_htslib::bam::IndexedReader

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

Fields

header: HeaderView

Methods

impl IndexedReader

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

Create a new Reader from path.

Arguments

• path - the path to open.

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

fn seek(&mut self, tid: u32, beg: u32, end: u32) -> Result<(), SeekError>

Trait Implementations

impl Send for IndexedReader

impl Read for IndexedReader

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

fn header(&self) -> &HeaderView

Return the header.

impl Drop for IndexedReader

fn drop(&mut self)

A method called when the value goes out of scope.