Struct noodles_vcf::indexed_reader::IndexedReader

pub struct IndexedReader<R> { /* private fields */ }

An indexed VCF reader.

Implementations

impl<R> IndexedReader<R>where R: Read,

pub fn new(inner: R, index: Index) -> Self

Creates an indexed VCF reader.

pub fn get_ref(&self) -> &Reader<R>

Returns a reference to the underlying reader.

pub fn get_mut(&mut self) -> &mut Reader<R>

Returns a mutable reference to the underlying reader.

pub fn into_inner(self) -> Reader<R>

Returns the underlying reader.

pub fn read_header(&mut self) -> Result<Header>

Reads the VCF header.

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

Reads a single raw VCF record.

pub fn records<'r, 'h>( &'r mut self, header: &'h Header ) -> Records<'r, 'h, Reader<R>>

Returns an iterator over records starting from the current stream position.

pub fn index(&self) -> &Index

Returns the associated index.

impl<R> IndexedReader<R>where R: Read + Seek,

pub fn query<'r, 'h>( &'r mut self, header: &'h Header, region: &Region ) -> Result<Query<'r, 'h, R>>

Returns an iterator over records that intersects the given region.