Struct Writer

pub struct Writer<W> { /* private fields */ }

An async FASTQ writer.

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_fastq as fastq;
use tokio::io;
let writer = fastq::r#async::io::Writer::new(io::sink());
let _inner = writer.get_ref();

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

Returns a mutable reference to the underlying writer.

Examples

use noodles_fastq as fastq;
use tokio::io;
let mut writer = fastq::r#async::io::Writer::new(io::sink());
let _inner = writer.get_mut();

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_fastq as fastq;
use tokio::io;
let writer = fastq::r#async::io::Writer::new(io::sink());
let _inner = writer.into_inner();

impl<W> Writer<W>

where W: AsyncWrite + Unpin,

pub fn new(inner: W) -> Self

Creates an async FASTQ writer.

Examples

use noodles_fastq as fastq;
use tokio::io;
let writer = fastq::r#async::io::Writer::new(io::sink());

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

Writes a FASTQ record.

Examples

use noodles_fastq::{self as fastq, record::Definition};

let mut writer = fastq::r#async::io::Writer::new(Vec::new());

let record = fastq::Record::new(Definition::new("r0", ""), "ATCG", "NDLS");
writer.write_record(&record).await?;

assert_eq!(writer.get_ref(), b"@r0\nATCG\n+\nNDLS\n");