Struct Writer

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

An async BAM index (BAI) writer.

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_bam::bai;
use tokio::io;
let writer = bai::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_bam::bai;
use tokio::io;
let mut writer = bai::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_bam::bai;
use tokio::io;
let writer = bai::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 BAM index (BAI) writer.

Examples

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

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

Shuts down the output stream.

Examples

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

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

Writes a BAM index.

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

Examples

use noodles_bam::bai;

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

let mut writer = bai::r#async::io::Writer::new(Vec::new());
writer.write_index(&index).await?;