Struct rust_htslib::bcf::buffer::RecordBuffer
[−]
[src]
pub struct RecordBuffer { /* fields omitted */ }A buffer for BCF records. This allows access regions in a sorted BCF file while iterating over it in a single pass. The buffer is implemented as a ringbuffer, such that extension or movement to the right has linear complexity. The buffer does not use any indexed random access. Hence, for getting a region at the very end of the BCF, you will have to wait until all records before have been read.
Methods
impl RecordBuffer[src]
pub fn new(reader: Reader) -> Self[src]
Create new buffer.
pub fn fetch(
&mut self,
chrom: &[u8],
start: u32,
end: u32
) -> Result<(usize, usize), Box<Error>>[src]
&mut self,
chrom: &[u8],
start: u32,
end: u32
) -> Result<(usize, usize), Box<Error>>
Fill the buffer with variants in the given window. The start coordinate has to be right of
the start coordinate of any previous fill operation.
Coordinates are 0-based, and end is exclusive.
Returns tuple with numbers of added and deleted records compared to previous fetch.
ⓘImportant traits for Iter<'a, T>pub fn iter(&self) -> Iter<Record>[src]
Iterate over records that have been fetched with fetch.
ⓘImportant traits for IterMut<'a, T>pub fn iter_mut(&mut self) -> IterMut<Record>[src]
Iterate over mutable references to records that have been fetched with fetch.
pub fn len(&self) -> usize[src]
Trait Implementations
impl Debug for RecordBuffer[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result[src]
Formats the value using the given formatter. Read more