Struct Writer

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

An async BAM writer.

Implementations

impl<W> Writer<W>

where W: AsyncWrite + Unpin,

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

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

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

Returns a mutable reference to the underlying writer.

Examples

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

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

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

pub async fn shutdown(&mut self) -> Result<()>

Shuts down the output stream.

Examples

use noodles_bam as bam;
let mut writer = bam::r#async::io::Writer::new(Vec::new());
writer.shutdown().await?;

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

Writes a SAM header.

This writes the BAM magic number, the raw SAM header, and a copy of the reference sequence dictionary as binary reference sequences.

Examples

use noodles_bam as bam;
use noodles_sam as sam;

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

let header = sam::Header::default();
writer.write_header(&header).await?;

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

Writes a BAM record.

Examples

use noodles_bam as bam;
use noodles_sam as sam;

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

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

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

Writes an alignment record.

Examples

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

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

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

impl<W> Writer<AsyncWriter<W>>

where W: AsyncWrite + Unpin,

pub fn new(inner: W) -> Self

Creates an async BAM writer with a default compression level.

The given stream is wrapped in a BGZF encoder.

Examples

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

Trait Implementations

impl<W> From<W> for Writer<W>

fn from(inner: W) -> Self

Converts to this type from the input type.