Struct Index

pub struct Index<I> { /* private fields */ }

A binning index.

Implementations

impl<I> Index<I>

where I: Index,

pub fn builder() -> Builder<I>

Returns a builder to create an index from each of its fields.

Examples

use noodles_csi as csi;
let builder = csi::Index::builder();

pub fn reference_sequences(&self) -> &[ReferenceSequence<I>]

Returns a list of indexed reference sequences.

Examples

use noodles_csi as csi;
let index = csi::Index::default();
assert!(index.reference_sequences().is_empty());

Trait Implementations

impl<I> BinningIndex for Index<I>

where I: Index,

fn min_shift(&self) -> u8

Returns the number of bits for the minimum interval.

fn depth(&self) -> u8

Returns the depth of the binning index.

fn header(&self) -> Option<&Header>

Returns the tabix header.

fn reference_sequences( &self, ) -> Box<dyn Iterator<Item = &dyn ReferenceSequence> + '_>

Returns an iterator over reference sequences.

fn unplaced_unmapped_record_count(&self) -> Option<u64>

Returns the number of unplaced, unmapped records in the associated file.

fn query( &self, reference_sequence_id: usize, interval: Interval, ) -> Result<Vec<Chunk>>

Returns the chunks that overlap with the given region.

fn last_first_record_start_position(&self) -> Option<VirtualPosition>

Returns the last first record start position.

impl<I: Clone> Clone for Index<I>

fn clone(&self) -> Index<I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Debug> Debug for Index<I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I> Default for Index<I>

where I: Index,

fn default() -> Self

Returns the “default value” for a type.

impl<I: PartialEq> PartialEq for Index<I>

fn eq(&self, other: &Index<I>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: Eq> Eq for Index<I>

impl<I> StructuralPartialEq for Index<I>