Struct noodles_tabix::index::Index [−][src]
pub struct Index { /* fields omitted */ }
Expand description
A tabix index.
Implementations
Returns a builder to create an index from each of its fields.
Examples
use noodles_tabix as tabix;
let builder = tabix::Index::builder();
Returns the header.
Examples
use noodles_tabix as tabix;
let header = tabix::index::Header::default();
let index = tabix::Index::builder().set_header(header.clone()).build();
assert_eq!(index.header(), &header);
Returns the reference sequence names.
Examples
use noodles_tabix::{self as tabix, index::ReferenceSequenceNames};
let reference_sequence_names: ReferenceSequenceNames = vec![String::from("sq0")]
.into_iter()
.collect();
let index = tabix::Index::builder()
.set_reference_sequence_names(reference_sequence_names.clone())
.build();
assert_eq!(index.reference_sequence_names(), &reference_sequence_names);
👎 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_tabix as tabix;
let index = tabix::Index::builder()
.set_unmapped_read_count(21)
.build();
assert_eq!(index.unmapped_read_count(), Some(21));
Trait Implementations
Returns a list of indexed reference sequences.
Examples
use noodles_csi::BinningIndex;
use noodles_tabix as tabix;
let index = tabix::Index::default();
assert!(index.reference_sequences().is_empty());
Returns the number of unplaced, unmapped records in the associated file.
Examples
use noodles_csi::BinningIndex;
use noodles_tabix as tabix;
let index = tabix::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