Struct Reader

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

A CSI reader.

Implementations

impl<R> Reader<R>

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

Returns a reference to the underlying reader.

Examples

use noodles_csi as csi;
let reader = csi::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_csi as csi;
let mut reader = csi::io::Reader::new(io::empty());
let _inner = reader.get_mut();

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

Returns the underlying reader.

Examples

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

impl<R> Reader<R>

where R: Read,

pub fn new(inner: R) -> Self

Creates a CSI reader.

Examples

use noodles_csi as csi;
let reader = File::open("sample.bcf.csi").map(csi::io::Reader::new)?;

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

Reads a CSI index.

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

Examples

use noodles_csi as csi;
let mut reader = File::open("sample.bcf.csi").map(csi::io::Reader::new)?;
let index = reader.read_index();