Struct Writer

Source

pub struct Writer<W>where
    W: AsyncWrite,
{ /* private fields */ }

Expand description

An async SAM writer.

Implementations§

Source §

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

Source

pub fn new(inner: W) -> Self

Creates an async SAM writer.

§Examples

use noodles_sam as sam;
let writer = sam::r#async::io::Writer::new(Vec::new());

Source

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

§Examples

use noodles_sam as sam;
let writer = sam::r#async::io::Writer::new(Vec::new());
assert!(writer.get_ref().is_empty());

Source

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

Returns a mutable reference to the underlying writer.

§Examples

use noodles_sam as sam;
let mut writer = sam::r#async::io::Writer::new(Vec::new());
assert!(writer.get_mut().is_empty());

Source

pub fn into_inner(self) -> W

Returns the underlying writer.

§Examples

use noodles_sam as sam;
let writer = sam::r#async::io::Writer::new(Vec::new());
assert!(writer.into_inner().is_empty());

Source

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

Writes a SAM header.

The SAM header is optional, though recommended to include. A call to this method can be omitted if it is empty.

§Examples

use noodles_sam as sam;

let mut writer = sam::r#async::io::Writer::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");

Source

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

Writes a SAM record.

§Examples

use noodles_sam as sam;

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

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

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

Source

pub async fn write_alignment_record( &mut self, header: &Header, record: &dyn Record, ) -> Result<()>

Writes an alignment record.

§Examples

use noodles_sam::{self as sam, alignment::RecordBuf};

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

let header = sam::Header::default();
let record = RecordBuf::default();
writer.write_alignment_record(&header, &record).await?;

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