Struct noodles_bam::bai::AsyncWriter

pub struct AsyncWriter<W> { /* fields omitted */ }

An async BAM index (BAI) writer.

Implementations

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

pub fn new(inner: W) -> Self

Creates an async BAM index (BAI) writer.

Examples

use noodles_bam::bai;
let writer = bai::AsyncWriter::new(Vec::new());

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_bam::bai;
let writer = bai::AsyncWriter::new(Vec::new());
assert!(writer.into_inner().is_empty());

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

Shuts down the output stream.

Examples

use noodles_bam::bai;
let mut writer = bai::AsyncWriter::new(Vec::new());
writer.shutdown().await?;

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

Writes a BAM index (BAI) header.

The position of the stream is expected to be at the start.

Examples

use noodles_bam::bai;
let mut writer = bai::AsyncWriter::new(Vec::new());
writer.write_header().await?;

pub async fn write_index(&mut self, index: &Index) -> Result<()>

Writes a BAM index.

The position of the stream is expected to be directly after the header.

Examples

use noodles_bam::bai;

let index = bai::Index::default();

let mut writer = bai::AsyncWriter::new(Vec::new());
writer.write_header().await?;
writer.write_index(&index).await?;