Struct noodles_bgzf::MultithreadedReader

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

A multithreaded BGZF reader.

This is a multithreaded BGZF reader that uses a thread pool to decompress block data. It places the inner reader on its own thread to read raw frames asynchronously.

Implementations

impl<R> MultithreadedReader<R>

pub fn position(&self) -> u64

Returns the current position of the stream.

Examples

use noodles_bgzf as bgzf;
let reader = bgzf::MultithreadedReader::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;
let reader = bgzf::MultithreadedReader::new(io::empty());
assert_eq!(reader.virtual_position(), bgzf::VirtualPosition::MIN);

pub fn finish(&mut self) -> Result<R>

Shuts down the reader.

Examples

use noodles_bgzf as bgzf;
let mut reader = bgzf::MultithreadedReader::new(io::empty());
reader.finish()?;

impl<R> MultithreadedReader<R>

where R: Read + Send + 'static,

pub fn new(inner: R) -> Self

Creates a multithreaded BGZF reader with a worker count of 1.

Examples

use noodles_bgzf as bgzf;
let reader = bgzf::MultithreadedReader::new(io::empty());

pub fn with_worker_count(worker_count: NonZeroUsize, inner: R) -> Self

Creates a multithreaded BGZF reader with a worker count.

Examples

use std::num::NonZeroUsize;
use noodles_bgzf as bgzf;
let reader = bgzf::MultithreadedReader::with_worker_count(NonZeroUsize::MIN, io::empty());

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

Returns a mutable reference to the underlying reader.

Examples

use noodles_bgzf as bgzf;
let mut reader = bgzf::MultithreadedReader::new(io::empty());
let _inner = reader.get_mut();

Trait Implementations

impl<R> BufRead for MultithreadedReader<R>

where R: Read + Send + 'static,

fn fill_buf(&mut self) -> Result<&[u8]>

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

fn consume(&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 read.

fn has_data_left(&mut self) -> Result<bool, Error>

🔬This is a nightly-only experimental API. (buf_read_has_data_left)

Checks if the underlying Read has any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

🔬This is a nightly-only experimental API. (bufread_skip_until)

Skips all bytes until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<R> Drop for MultithreadedReader<R>

fn drop(&mut self)

Executes the destructor for this type.

impl<R> Read for MultithreadedReader<R>

where R: Read + Send + 'static,

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Reads the exact number of bytes required to fill buf.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<R> Read for MultithreadedReader<R>

where R: Read + Send + 'static,

fn virtual_position(&self) -> VirtualPosition

Returns the current virtual position.

impl<R> Seek for MultithreadedReader<R>

where R: Read + Send + Seek + 'static,

fn seek_to_virtual_position( &mut self, pos: VirtualPosition, ) -> Result<VirtualPosition>

Seeks the stream to the given virtual position.

fn seek_with_index(&mut self, index: &Index, pos: SeekFrom) -> Result<u64>

Seeks the stream to the given position using an index.

impl<R> BufRead for MultithreadedReader<R>

where R: Read + Send + 'static,