[−][src]Struct rust_htslib::bcf::synced::SyncedReader
A wrapper for bcf_srs_t
; allows joint traversal of multiple VCF and/or BCF files.
Methods
impl SyncedReader
[src]
pub fn new() -> Result<Self, AllocationError>
[src]
pub fn set_require_index(&mut self, do_require: bool)
[src]
Enable or disable requiring of index
pub fn set_pairing(&mut self, bitmask: u32)
[src]
Set the given bitmask of values from sr_pairing
module.
pub fn add_reader<P: AsRef<Path>>(&mut self, path: P) -> Result<(), BCFError>
[src]
Add new reader with the path to the file.
pub fn remove_reader(&mut self, idx: u32)
[src]
Remove reader with the given index.
pub fn reader_count(&self) -> u32
[src]
Return number of open files/readers.
pub fn read_next(&mut self) -> Result<u32, ReadError>
[src]
Read next line and return number of readers that have the given line.
pub fn has_line(&self, idx: u32) -> bool
[src]
Return whether the given reader has the line.
pub fn record(&self, idx: u32) -> Option<Record>
[src]
Return record from the given reader, if any.
pub fn header(&self, idx: u32) -> &HeaderView
[src]
Return header from the given reader.
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 Drop for SyncedReader
[src]
impl Debug for SyncedReader
[src]
Auto Trait Implementations
impl !Send for SyncedReader
impl !Sync for SyncedReader
Blanket Implementations
impl<T> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,