Trait noodles::csi::BinningIndex

pub trait BinningIndex<R> where
    R: BinningIndexReferenceSequence, {
    fn reference_sequences(&self) -> &[R];
    fn unplaced_unmapped_record_count(&self) -> Option<u64>;
    fn query<B>(
        &self, 
        reference_sequence_id: usize, 
        interval: B
    ) -> Result<Vec<Chunk, Global>, Error>
    where
        B: RangeBounds<i32> + Clone;

    fn first_record_in_last_linear_bin_start_position(
        &self
    ) -> Option<VirtualPosition> { ... }
}

A binning index.

Required methods

fn reference_sequences(&self) -> &[R]

Returns a list of indexed reference sequences.

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

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

fn query<B>(
    &self,
    reference_sequence_id: usize,
    interval: B
) -> Result<Vec<Chunk, Global>, Error> where
    B: RangeBounds<i32> + Clone, 

Returns the chunks that overlap with the given region.

Provided methods

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

Returns the start position of the first record in the last linear bin.

This is the closest position to the unplaced, unmapped records, if any, that is available in an index.

Implementors

impl BinningIndex<ReferenceSequence> for noodles::bam::bai::Index

impl BinningIndex<ReferenceSequence> for noodles::tabix::Index

impl BinningIndex<ReferenceSequence> for noodles::csi::Index