Module noodles_bam::bai [−][src]
Expand description
BAM index (BAI) and fields.
A BAM index (BAI) is used with an associated coordinate-sorted BAM file that allows random access to records, e.g., querying.
The index contains a list of reference sequences parallel to the one defined in the BAM file. Each indexed reference sequence has a calculated set of hierarchical bins at different granularities. The bins then define a list of physical file positions in the BAM to search for overlapping records.
When reading entire BAM files sequentially, a BAM index is not necessary.
Examples
Reading a BAM index
use noodles_bam::bai;
let index = bai::read("sample.bam.bai")?;Re-exports
pub use self::index::Index;Modules
Structs
An async BAM index (BAI) reader.
An async BAM index (BAI) writer.
A BAM index (BAI) reader.
A BAM index (BAI) writer.