Struct Reader

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

An async FASTA reader.

Implementations

impl<R> Reader<R>

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

use noodles_fasta as fasta;
use tokio::io;
let reader = fasta::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_fasta as fasta;
use tokio::io;
let mut reader = fasta::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_fasta as fasta;
use tokio::io;
let reader = fasta::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 FASTA reader.

Examples

use noodles_fasta as fasta;
let data = [];
let mut reader = fasta::r#async::io::Reader::new(&data[..]);

pub async fn read_definition(&mut self, buf: &mut String) -> Result<usize>

Reads a raw definition line.

Examples

use noodles_fasta as fasta;

let data = b">sq0\nACGT\n>sq1\nNNNN\nNNNN\nNN\n";
let mut reader = fasta::r#async::io::Reader::new(&data[..]);

let mut buf = String::new();
reader.read_definition(&mut buf).await?;

assert_eq!(buf, ">sq0");

pub async fn read_sequence(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Reads a sequence.

Examples

use noodles_fasta as fasta;

let data = b">sq0\nACGT\n>sq1\nNNNN\nNNNN\nNN\n";
let mut reader = fasta::r#async::io::Reader::new(&data[..]);
reader.read_definition(&mut String::new()).await?;

let mut buf = Vec::new();
reader.read_sequence(&mut buf).await?;

assert_eq!(buf, b"ACGT");

impl<R> Reader<R>

where R: AsyncRead + AsyncSeek + Unpin,

pub async fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seeks the underlying stream to the given position.