Struct noodles_sam::AsyncWriter

pub struct AsyncWriter<W> where
    W: AsyncWrite,  { /* fields omitted */ }

An async SAM writer.

Implementations

impl<W> Writer<W> where
    W: AsyncWrite + Unpin, 

pub fn new(inner: W) -> Self

Creates an async SAM writer.

Examples

use noodles_sam as sam;
let writer = sam::AsyncWriter::new(Vec::new());

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_sam as sam;
let writer = sam::AsyncWriter::new(Vec::new());
assert!(writer.get_ref().is_empty());

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_sam as sam;
let writer = sam::AsyncWriter::new(Vec::new());
assert!(writer.into_inner().is_empty());

pub async fn write_header(&mut self, header: &Header) -> Result<()>

Writes a SAM header.

Examples

use noodles_sam as sam;

let mut writer = sam::AsyncWriter::new(Vec::new());

let header = sam::Header::builder().add_comment("noodles-sam").build();
writer.write_header(&header).await?;

assert_eq!(writer.get_ref(), b"@CO\tnoodles-sam\n");

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

Writes a SAM record.

Examples

use noodles_sam as sam;

let mut writer = sam::AsyncWriter::new(Vec::new());

let record = sam::Record::default();
writer.write_record(&record).await?;

assert_eq!(writer.get_ref(), b"*\t4\t*\t0\t255\t*\t*\t0\t0\t*\t*\n");