Struct noodles::bam::bai::Index [−][src]
pub struct Index { /* fields omitted */ }
Expand description
A BAM index.
Implementations
👎 Deprecated since 0.2.0: Use unplaced_unmapped_record_count
instead.
Use unplaced_unmapped_record_count
instead.
Returns the number of unplaced unmapped reads in the associated BAM file.
An unplaced unmapped read is a read that is has neither a reference sequence ID nor position set.
Examples
use noodles_bam::bai;
let index = bai::Index::default();
assert_eq!(index.unplaced_unmapped_read_count(), None);
let index = bai::Index::new(Vec::new(), Some(13));
assert_eq!(index.unplaced_unmapped_read_count(), Some(13));
Trait Implementations
Returns a list of indexed reference sequences.
This list is parallel to the reference sequences defined in the associated BAM file.
Examples
use noodles_bam::bai;
use noodles_csi::BinningIndex;
let index = bai::Index::default();
assert!(index.reference_sequences().is_empty());
Returns the number of unplaced, unmapped records in the associated file.
An unplaced, unmapped record is one that is has neither a reference sequence ID nor position set.
Examples
use noodles_bam::bai;
use noodles_csi::BinningIndex;
let index = bai::Index::default();
assert!(index.unplaced_unmapped_record_count().is_none());
Returns the chunks that overlap with the given region.
Returns the start position of the first record in the last linear bin. Read more
Auto Trait Implementations
impl RefUnwindSafe for Index
impl UnwindSafe for Index
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.