Struct LocusWalk 

pub struct LocusWalk { /* private fields */ }

Implementations

impl LocusWalk

pub fn plan(reader: &BamReader, req: &EntriesRequest) -> Result<Self>

A per-locus walk: every alignment its locus overlaps, boundaries and all.

pub fn restarted(&self) -> Self

The same walk, back at its first locus.

Shares the plan, so this is one refcount bump however many loci it holds. The progress tracker is fresh: a second pass reports its own progress from zero, which is what a caller watching it expects.

pub fn plan_windows( reader: &BamReader, req: &EntriesRequest, span: i64, ) -> Result<Self>

The same plan, for a walk that tiles whole references.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn order(&self) -> &[usize]

Request index of each yielded list: the nth list belongs to locus order()[n].

pub fn next_window( &mut self, reader: &BamReader, ) -> Option<Result<Vec<BamRecord>>>

Trait Implementations

impl Debug for LocusWalk

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

Formats the value using the given formatter.