Struct noodles_csi::index::Index [−][src]
pub struct Index { /* fields omitted */ }
Expand description
A coordinate-sorted index (CSI).
Implementations
Returns a builder to create an index from each of its fields.
Examples
use noodles_csi as csi; let builder = csi::Index::builder();
Returns the number of bits for the minimum interval.
Examples
use noodles_csi as csi; let index = csi::Index::default(); assert_eq!(index.min_shift(), 14);
Returns the depth of the binning index.
Examples
use noodles_csi as csi; let index = csi::Index::default(); assert_eq!(index.depth(), 5);
Returns the auxiliary data.
Examples
use noodles_csi as csi; let index = csi::Index::default(); assert!(index.aux().is_empty());
👎 Deprecated since 0.2.0: Use unplaced_unmapped_record_count
instead.
👎 Deprecated since 0.2.0:
Use unplaced_unmapped_record_count
instead.
Returns the number of unmapped records in the associated file.
Examples
use noodles_csi as csi; let index = csi::Index::default(); assert!(index.unmapped_read_count().is_none());
Trait Implementations
Returns a list of indexed reference sequences.
Examples
use noodles_csi::{self as csi, BinningIndex}; let index = csi::Index::default(); assert!(index.reference_sequences().is_empty());
Returns the number of unplaced, unmapped records in the associated file.
Examples
use noodles_csi::{self as csi, BinningIndex}; let index = csi::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