Struct FastqReader

Source

pub struct FastqReader<R: Read> { /* private fields */ }

Expand description

Generic FASTQ reader supporting any Read source.

Use FastqReader<File> for plain files or FastqReader<MultiGzDecoder<File>> for gzipped files.

Implementations§

Source §

impl FastqReader<File>

Source

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Opens a plain (uncompressed) FASTQ file.

§Arguments

path - Path to the FASTQ file

Source §

impl FastqReader<MultiGzDecoder<File>>

Source

pub fn open_gz<P: AsRef<Path>>(path: P) -> Result<Self>

Opens a gzip-compressed FASTQ file.

§Arguments

path - Path to the .fastq.gz or .fq.gz file

Source §

impl<R: Read> FastqReader<R>

Source

pub fn read_next(&mut self) -> Result<Option<FastqRecord>>

Reads the next FASTQ record (4 lines per record).

§FASTQ Format

@read_name
SEQUENCE
+
QUALITY

§Returns

Ok(Some(record)) - Successfully read a record
Ok(None) - End of file reached
Err(e) - I/O or format error

Auto Trait Implementations§

§

impl<R> UnwindSafe for FastqReader<R>
where R: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §