Trait rust_htslib::tbx::Read

pub trait Read: Sized {
    fn read(&mut self, record: &mut Vec<u8>) -> Result<bool>;
    fn records(&mut self) -> Records<Self>;
    fn header(&self) -> &Vec<String>;
}

A trait for a Tabix reader with a read method.

Required methods

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

Important traits for Records<'a, R>

impl<'a, R: Read> Iterator for Records<'a, R> type Item = Result<Vec<u8>>;

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>.

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

Return the text headers, split by line.

Loading content...

Implementors

impl Read for Reader

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

Important traits for Records<'a, R>

impl<'a, R: Read> Iterator for Records<'a, R> type Item = Result<Vec<u8>>;

fn records(&mut self) -> Records<Self>

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

Loading content...