Struct Reader

pub struct Reader<R>
where
    R: AsyncRead,
{ /* private fields */ }

An async tabix reader.

Implementations

impl<R> Reader<R>

where R: AsyncRead + Unpin,

pub fn new(inner: R) -> Self

Creates an async tabix reader.

Examples

use noodles_tabix as tabix;
let data = [];
let reader = tabix::r#async::io::Reader::new(&data[..]);

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

Returns a reference to the underlying reader.

Examples

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

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

Returns a mutable reference to the underlying reader.

Examples

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

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

Returns the underlying reader.

Examples

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

pub async 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;
use tokio::fs::File;

let mut reader = File::open("sample.vcf.gz.tbi")
    .await
    .map(tabix::r#async::io::Reader::new)?;

let index = reader.read_index().await?;