Struct Reader

pub struct Reader<R> { /* private fields */ }

An async BAM index (BAI) reader.

Implementations

impl<R> Reader<R>

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

use noodles_bam::bai;
use tokio::io;
let reader = bai::r#async::io::Reader::new(io::empty());
let _inner = reader.get_ref();

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

Returns a mutable reference to the underlying reader.

Examples

use noodles_bam::bai;
use tokio::io;
let mut reader = bai::r#async::io::Reader::new(io::empty());
let _inner = reader.get_mut();

pub fn into_inner(self) -> R

Returns the underlying reader.

Examples

use noodles_bam::bai;
use tokio::io;
let reader = bai::r#async::io::Reader::new(io::empty());
let _inner = reader.into_inner();

impl<R> Reader<R>

where R: AsyncRead + Unpin,

pub fn new(inner: R) -> Self

Creates an async BAM index (BAI) reader.

Examples

use noodles_bam::bai;
let data = [];
let reader = bai::r#async::io::Reader::new(&data[..]);

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

Reads the BAM index.

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

Examples

use noodles_bam::bai;
use tokio::fs::File;

let mut reader = File::open("sample.bam.bai")
    .await
    .map(bai::r#async::io::Reader::new)?;

let index = reader.read_index().await?;