Struct rust_htslib::bgzf::Reader

pub struct Reader { /* fields omitted */ }

A reader that transparently reads uncompressed, gzip, and bgzip files.

Implementations

impl Reader

pub fn from_stdin() -> Result<Self, Error>

Create a new Reader to read from stdin.

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

Create a new Reader from a path.

Arguments

• path - the path to open.

pub fn from_url(url: &Url) -> Result<Self, Error>

Create a new Reader from an URL.

Arguments

• url - the url to open

pub fn set_thread_pool(&mut self, tpool: &ThreadPool) -> Result<()>

Set the thread pool to use for parallel decompression.

Arguments

• tpool - the thread-pool to use

Trait Implementations

impl Debug for Reader

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Read for Reader

pub 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.

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

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

pub 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.

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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