Struct Query 

pub struct Query<'r, R> { /* private fields */ }

A reader over records of a BAM reader that intersects a given region.

This is created by calling super::Reader::query.

Implementations

impl<'r, R> Query<'r, R>

where R: BufRead + Seek,

pub fn read_record(&mut self, record: &mut Record) -> Result<usize>

Reads a record.

Examples

use noodles_bam::{self as bam, bai};

let mut reader = File::open("sample.bam").map(bam::io::Reader::new)?;
let header = reader.read_header()?;

let index = bai::fs::read("sample.bam.bai")?;
let region = "sq0:8-13".parse()?;
let mut query = reader.query(&header, &index, &region)?;

let mut record = bam::Record::default();

while query.read_record(&mut record)? != 0 {
    // ...
}

pub fn records(self) -> Records<'r, R>

Returns an iterator over records.

use noodles_bam::{self as bam, bai};

let mut reader = File::open("sample.bam").map(bam::io::Reader::new)?;
let header = reader.read_header()?;

let index = bai::fs::read("sample.bam.bai")?;
let region = "sq0:8-13".parse()?;
let query = reader.query(&header, &index, &region)?;

let mut record = bam::Record::default();

for result in query.records() {
    let record = result?;
    // ...
}