pub struct Reader<B> { /* private fields */ }
Expand description
A FastQ reader.
Implementations
sourceimpl<B> Reader<B> where
B: BufRead,
impl<B> Reader<B> where
B: BufRead,
sourcepub fn from_bufread(bufreader: B) -> Self
pub fn from_bufread(bufreader: B) -> Self
Create a new Fastq reader with an object that implements io::BufReader
.
sourcepub fn records(self) -> Records<B>ⓘNotable traits for Records<B>impl<B> Iterator for Records<B> where
B: BufRead, type Item = Result<Record>;
pub fn records(self) -> Records<B>ⓘNotable traits for Records<B>impl<B> Iterator for Records<B> where
B: BufRead, type Item = Result<Record>;
B: BufRead, type Item = Result<Record>;
Return an iterator over the records of this FastQ file.
Errors
This function will return an error if a record is incomplete or syntax is violated.
Example
use bio::io::fastq;
let fq: &'static [u8] = b"@id description\nACGT\n+\n!!!!\n";
let records = fastq::Reader::new(fq)
.records()
.map(|record| record.unwrap());
for record in records {
assert!(record.check().is_ok())
}
Trait Implementations
sourceimpl<B> FastqRead for Reader<B> where
B: BufRead,
impl<B> FastqRead for Reader<B> where
B: BufRead,
sourcefn read(&mut self, record: &mut Record) -> Result<()>
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");
Auto Trait Implementations
impl<B> RefUnwindSafe for Reader<B> where
B: RefUnwindSafe,
impl<B> Send for Reader<B> where
B: Send,
impl<B> Sync for Reader<B> where
B: Sync,
impl<B> Unpin for Reader<B> where
B: Unpin,
impl<B> UnwindSafe for Reader<B> where
B: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.