Struct rust_htslib::bcf::IndexedReader
[−]
[src]
pub struct IndexedReader { /* fields omitted */ }
An indexed VCF/BCF reader.
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]
Create a new IndexedReader
from an URL.
pub fn fetch(
&mut self,
rid: u32,
start: u32,
end: u32
) -> Result<(), FetchError>
[src]
&mut self,
rid: u32,
start: u32,
end: u32
) -> Result<(), FetchError>
Jump to the given region.
Arguments
rid
- numeric ID of the reference to jump to; useHeaderView::name2rid
for resolving contig name to ID.start
-0
-based start coordinate of region on reference.end
-0
-based end coordinate of region on reference.
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 the next record. Read more
ⓘImportant traits for Records<'a, R>fn records(&mut self) -> Records<Self>
[src]
ⓘImportant traits for Records<'a, R>
Return an iterator over all records of the VCF/BCF file.
fn set_threads(&mut self, n_threads: usize) -> Result<(), ThreadingError>
[src]
Activate multi-threaded BCF/VCF read support in htslib. This should permit faster reading of large VCF files. Read more
fn header(&self) -> &HeaderView
[src]
Return the header.
fn empty_record(&self) -> Record
[src]
Return empty record. Can be reused multiple times.