Struct FastqBatch 

pub struct FastqBatch<'a> { /* private fields */ }

A batch of borrowed FASTQ records from one reader slab.

The batch is invalidated by the next mutable call on the reader that produced it. Process records before requesting another batch.

Implementations

impl<'a> FastqBatch<'a>

pub fn len(&self) -> usize

Number of records in the batch.

pub fn is_empty(&self) -> bool

Whether the batch has no records.

pub fn bytes(&self) -> &'a [u8]

Raw slab bytes backing this batch.

pub fn record_refs(&self) -> &'a [RecordRef]

Record ranges within bytes.

pub fn base_offset(&self) -> u64

Absolute byte offset of bytes()[0] in the original stream.

pub fn first_record_index(&self) -> u64

Zero-based index of the first record in this batch.

pub fn pair_validation(&self) -> PairValidation

Pair validation mode inherited from the producing reader.

pub fn records(&self) -> impl Iterator<Item = FastqRecord<'a>> + 'a

Iterate borrowed record views.

pub fn interleaved_pairs(&'a self) -> Result<InterleavedPairs<'a>>

Validate and iterate adjacent interleaved read pairs.

Returns an error if the batch has an odd record count or mate identifiers fail the configured PairValidation mode.

pub fn paired_with( &'a self, mate: &'a FastqBatch<'a>, ) -> Result<PairedRecords<'a>>

Validate and zip this batch with a mate batch from a separate reader.

Identifier checks use this batch’s configured PairValidation mode.

Trait Implementations

impl<'a> Debug for FastqBatch<'a>

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

Formats the value using the given formatter.