Struct noodles_fastq::async::io::Reader

pub struct Reader<R> { /* private fields */ }

An async FASTQ reader.

Implementations

impl<R> Reader<R>

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

use noodles_fastq as fastq;
use tokio::io;
let reader = fastq::r#async::io::Reader::new(io::empty());
let _inner = reader.get_ref();

pub fn get_mut(&mut self) -> &mut R

Returns a mutable reference to the underlying reader.

Examples

use noodles_fastq as fastq;
use tokio::io;
let mut reader = fastq::r#async::io::Reader::new(io::empty());
let _inner = reader.get_mut();

pub fn into_inner(self) -> R

Returns the underlying reader.

Examples

use noodles_fastq as fastq;
use tokio::io;
let reader = fastq::r#async::io::Reader::new(io::empty());
let _inner = reader.into_inner();

impl<R> Reader<R>

where R: AsyncBufRead + Unpin,

pub fn new(inner: R) -> Self

Creates an async FASTQ reader.

Examples

use noodles_fastq as fastq;
use tokio::io;
let reader = fastq::r#async::io::Reader::new(io::empty());

pub async fn read_record(&mut self, record: &mut Record) -> Result<usize>

Reads a FASTQ record.

Examples

use noodles_fastq as fastq;

let data = b"@r0\nATCG\n+\nNDLS\n";
let mut reader = fastq::r#async::io::Reader::new(&data[..]);

let mut record = fastq::Record::default();
reader.read_record(&mut record).await?;

assert_eq!(record.name(), b"r0");
assert_eq!(record.sequence(), b"ATCG");
assert_eq!(record.quality_scores(), b"NDLS");

pub fn records(&mut self) -> impl Stream<Item = Result<Record>> + '_

Returns an (async) stream over records starting from the current (input) stream position.

Examples

use futures::TryStreamExt;
use noodles_fastq as fastq;

let data = b"@r0\nATCG\n+\nNDLS\n";
let mut reader = fastq::r#async::io::Reader::new(&data[..]);

let mut records = reader.records();

while let Some(record) = records.try_next().await? {
    // ...
}