Function read

pub async fn read<P>(src: P) -> Result<Index>
where
    P: AsRef<Path>,

Reads the entire contents of a BAM index.

This is a convenience function and is equivalent to opening the file at the given path, reading the header, and reading the index.

Examples

use noodles_bam::bai;
let index = bai::r#async::read("sample.bam.bai").await?;