Struct Query 

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

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

This is created by calling Reader::query.

Implementations

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

where R: BufRead + Seek,

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

Reads a record.

Example

use noodles_bgzf as bgzf;
use noodles_csi as csi;
use noodles_sam as sam;

let mut reader = File::open("sample.sam.gz")
    .map(bgzf::io::Reader::new)
    .map(sam::io::Reader::new)?;

let header = reader.read_header()?;

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

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

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

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

Returns an iterator over records.