Struct noodles_bgzf::gzi::Reader

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

A gzip index (GZI) reader.

Implementations

impl<R> Reader<R>

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

use noodles_bgzf::gzi;
let reader = gzi::Reader::new(io::empty());
let _inner = reader.get_ref();

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

Returns a mutable reference to the underlying reader.

Examples

use noodles_bgzf::gzi;
let mut reader = gzi::Reader::new(io::empty());
let _inner = reader.get_mut();

pub fn into_inner(self) -> R

Returns the underlying reader.

Examples

use noodles_bgzf::gzi;
let reader = gzi::Reader::new(io::empty());
let _inner = reader.into_inner();

impl<R> Reader<R>

where R: Read,

pub fn new(inner: R) -> Self

Creates a gzip index (GZI) reader.

Examples

use noodles_bgzf::gzi;
let data = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
let reader = gzi::Reader::new(&data[..]);

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

Reads a gzip index.

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

Examples

use noodles_bgzf::gzi;
let mut reader = File::open("in.gzi").map(gzi::Reader::new)?;
let index = reader.read_index()?;