Struct Reader

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

An async BGZF reader.

Implementations

impl<R> Reader<R>

where R: AsyncRead,

pub fn new(inner: R) -> Self

Creates an async BGZF reader.

Examples

use noodles_bgzf as bgzf;
use tokio::io;
let reader = bgzf::r#async::Reader::new(io::empty());

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Examples

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

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

Returns a mutable reference to the underlying stream.

Examples

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R>

Returns a pinned mutable reference to the underlying stream.

Examples

use noodles_bgzf as bgzf;
use tokio::io;
let mut reader = bgzf::r#async::Reader::new(io::empty());
let _inner = Pin::new(&mut reader).get_pin_mut();

pub fn into_inner(self) -> R

Unwraps and returns the underlying stream.

Examples

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

pub fn position(&self) -> u64

Returns the current position of the stream.

Examples

use noodles_bgzf as bgzf;
use tokio::io;
let reader = bgzf::r#async::Reader::new(io::empty());
assert_eq!(reader.position(), 0);

pub fn virtual_position(&self) -> VirtualPosition

Returns the current virtual position of the stream.

Examples

use noodles_bgzf as bgzf;
use tokio::io;
let reader = bgzf::r#async::Reader::new(io::empty());
assert_eq!(reader.virtual_position(), bgzf::VirtualPosition::from(0));

impl<R> Reader<R>

where R: AsyncRead + AsyncSeek + Unpin,

pub async fn seek(&mut self, pos: VirtualPosition) -> Result<VirtualPosition>

Seeks the stream to the given virtual position.

Examples

use noodles_bgzf as bgzf;
use tokio::io;
let mut reader = bgzf::r#async::Reader::new(io::empty());
reader.seek(bgzf::VirtualPosition::MIN).await?;

pub async fn seek_by_uncompressed_position( &mut self, index: &Index, pos: u64, ) -> Result<u64>

Seeks the stream to the given uncompressed position.

Examples

use noodles_bgzf::{self as bgzf, gzi};
use tokio::io;

let mut reader = bgzf::r#async::Reader::new(io::empty());

let index = gzi::Index::default();
reader.seek_by_uncompressed_position(&index, 0).await?;

Trait Implementations

impl<R> AsyncBufRead for Reader<R>

where R: AsyncRead,

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8]>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R> AsyncRead for Reader<R>

where R: AsyncRead,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<'__pin, R> Unpin for Reader<R>

where PinnedFieldsOf<__Origin<'__pin, R>>: Unpin, R: AsyncRead,