Struct Reader 

pub struct Reader { /* private fields */ }

Opaque decompression reader backed by the native rapidgzip engine.

Implementations

impl Reader

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Opens a gzip or BGZF file from a filesystem path using default settings.

pub fn open_reader<R: Read + Seek + Send + Sync + 'static>( reader: R, ) -> Result<Self, Error>

Opens a generic Read + Seek source with default settings.

Because generic readers cannot be cloned into independent handles, the native backend forces parallelism to 1 for this path.

pub fn export_index<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Error>

Exports the current random-access index to a file.

pub fn import_index<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Error>

Imports a previously exported random-access index from a file.

impl Reader

pub fn read_discard(&mut self, len: usize) -> Result<usize>

Reads and discards up to len decompressed bytes without copying them into Rust memory.

pub fn read_to_fd(&mut self, output_fd: RawFd, len: usize) -> Result<usize>

Streams decompressed bytes directly into a Unix file descriptor.

Trait Implementations

impl Drop for Reader

fn drop(&mut self)

Executes the destructor for this type.

impl Read for Reader

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_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_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill 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” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl Seek for Reader

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

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

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl Send for Reader