Function index

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

Indexes a BAM file.

The input must be coordinate-sorted and marked as such in the SAM header, i.e., SO:coordinate.

See also bai::fs::write to write the resulting bai::Index to a file.

Examples

use noodles_bam as bam;
let _index = bam::fs::index("sample.bam")?;