Struct needletail::formats::RecBuffer

pub struct RecBuffer<'a> {
    pub buf: Vec<u8>,
    pub last: bool,
    // some fields omitted
}

A buffer that wraps an object with the Read trait and allows extracting a set of slices to data. Acts as a lower-level primitive for our FASTX readers.

Fields

buf: Vec<u8>

last: bool

Methods

impl<'a> RecBuffer<'a>

pub fn new(
    file: &'a mut dyn Read,
    buf: Vec<u8>
) -> Result<RecBuffer<'a>, ParseError>

Instantiate a new buffer.

Panics

Under some very rare circumstances (setting a buf_size larger than 2 Gb on Mac OS X) a panic can occur. Please use a smaller buffer in this case.

pub fn refill(&mut self, used: usize) -> Result<bool, ParseError>

Refill the buffer and increase its capacity if it's not big enough. Takes a tuple of the bytes used and how many records returned so far.