Trait bio::io::fastq::FastqRead

pub trait FastqRead {
    fn read(&mut self, record: &mut Record) -> Result<()>;
}

Trait for FastQ readers.

Required methods

fn read(&mut self, record: &mut Record) -> Result<()>

Loading content...

Implementors

impl<R> FastqRead for Reader<R> where
    R: Read, 

fn read(&mut self, record: &mut Record) -> Result<()>

Read the next FastQ entry into the given Record. An empty record indicates that no more records can be read.

This method is useful when you want to read records as fast as possible because it allows the reuse of a Record allocation.

A more ergonomic approach to reading FastQ records is the records iterator.

FastQ files with wrapped sequence and quality strings are allowed.

Errors

This function will return an error if the record is incomplete, syntax is violated or any form of I/O error is encountered. Additionally, if the FastQ file has line-wrapped records, and the wrapping is not consistent between the sequence and quality string for a record, parsing will fail.

Example

use bio::io::fastq::Record;
use bio::io::fastq::{FastqRead, Reader};
const FASTQ_FILE: &'static [u8] = b"@id desc
AAAA
+
IIII
";
let mut reader = Reader::new(FASTQ_FILE);
let mut record = Record::new();

reader.read(&mut record).unwrap();

assert_eq!(record.id(), "id");
assert_eq!(record.desc().unwrap(), "desc");
assert_eq!(record.seq().to_vec(), b"AAAA");
assert_eq!(record.qual().to_vec(), b"IIII");

Loading content...