Struct Reader

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

A tabix reader.

Consider using crate::read to read the entire index at once.

Implementations

impl<R> Reader<R>

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

Returns a reference to the underlying reader.

Examples

use noodles_tabix as tabix;
let reader = tabix::io::Reader::new(io::empty());
let _inner = reader.get_ref();

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

Returns a mutable reference to the underlying reader.

Examples

use noodles_tabix as tabix;
let mut reader = tabix::io::Reader::new(io::empty());
let _inner = reader.get_mut();

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

Returns the underlying reader.

Examples

use noodles_tabix as tabix;
let reader = tabix::io::Reader::new(io::empty());
let _inner = reader.into_inner();

impl<R> Reader<R>

where R: Read,

pub fn new(reader: R) -> Self

Creates a tabix reader.

Examples

use noodles_tabix as tabix;;
let reader = File::open("sample.vcf.gz.tbi").map(tabix::io::Reader::new)?;

pub fn read_index(&mut self) -> Result<Index>

Reads the tabix index.

The position of the stream is expected to be at the beginning.

Examples

use noodles_tabix as tabix;;
let mut reader = File::open("sample.vcf.gz.tbi").map(tabix::io::Reader::new)?;
let index = reader.read_index()?;