Enum AlignmentWalk 

pub enum AlignmentWalk {
    Bam(LocusWalk),
    Cram(LocusWalk),
}

A walk over either format’s loci or windows.

Variants

Bam(LocusWalk)

Cram(LocusWalk)

Implementations

impl AlignmentWalk

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

A per-locus walk.

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

A walk over windows tiling whole references.

pub fn restarted(&self) -> Self

The same walk, back at its first locus, sharing the plan.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

The next window, from the reader this walk was planned against.

Handing it a reader of the other format is a caller’s mistake rather than a corrupt file, so it is Error::InvalidArgument — and it cannot happen through the Python layer, which holds the pair together.

Trait Implementations

impl Debug for AlignmentWalk

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

Formats the value using the given formatter.