Trait rust_htslib::tbx::Read

source · 
pub trait Read: Sized {
    // Required methods
    fn read(&mut self, record: &mut Vec<u8>) -> Result<bool>;
    fn records(&mut self) -> Records<'_, Self> ⓘ;
    fn header(&self) -> &Vec<String> ⓘ;
}
Expand description

A trait for a Tabix reader with a read method.

Required Methods§

source

fn read(&mut self, record: &mut Vec<u8>) -> Result<bool>

Read next line into the given Vec<u8> (i.e., ASCII string).

Use this method in combination with a single allocated record to avoid the reallocations occurring with the iterator.

Arguments
  • record - the Vec<u8> to be filled
Returns

Ok(true) if record was read, Ok(false) if no more record in file

source

fn records(&mut self) -> Records<'_, Self> ⓘ

Iterator over the lines/records of the seeked region.

Note that, while being convenient, this is less efficient than pre-allocating a Vec<u8> and reading into it with the read() method, since every iteration involves the allocation of a new Vec<u8>.

source

fn header(&self) -> &Vec<String> ⓘ

Return the text headers, split by line.

Implementors§