Struct rust_htslib::bam::IndexedReader
[−]
[src]
pub struct IndexedReader { /* fields omitted */ }
Methods
impl IndexedReader
[src]
pub fn from_path<P: AsRef<Path>>(
path: P
) -> Result<Self, IndexedReaderPathError>
[src]
path: P
) -> Result<Self, IndexedReaderPathError>
pub fn from_url(url: &Url) -> Result<Self, IndexedReaderError>
[src]
pub fn fetch(&mut self, tid: u32, beg: u32, end: u32) -> Result<(), FetchError>
[src]
Trait Implementations
impl Debug for IndexedReader
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Send for IndexedReader
[src]
impl Read for IndexedReader
[src]
fn read(&mut self, record: &mut Record) -> Result<(), ReadError>
[src]
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. Read more
ⓘImportant traits for Records<'a, R>fn records(&mut self) -> Records<Self>
[src]
ⓘImportant traits for Records<'a, R>
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
.
ⓘImportant traits for Pileups<'a, R>fn pileup(&mut self) -> Pileups<Self>
[src]
ⓘImportant traits for Pileups<'a, R>
Iterator over pileups.
fn bgzf(&self) -> *mut BGZF
[src]
Return the BGZF struct
fn header(&self) -> &HeaderView
[src]
Return the header.
fn seek(&mut self, offset: i64) -> Result<(), SeekError>
[src]
Seek to the given virtual offset in the file
fn tell(&self) -> i64
[src]
Report the current virtual offset
fn set_threads(&mut self, n_threads: usize) -> Result<(), ThreadingError>
[src]
Activate multi-threaded BAM read support in htslib. This should permit faster reading of large BAM files. Read more