Struct dbn::decode::DynReader

pub struct DynReader<'a, R>(/* private fields */)
where
    R: BufRead;

Type for runtime polymorphism over whether decoding uncompressed or ZStd-compressed DBN records. Implements std::io::Write.

Implementations

impl<'a, R> DynReader<'a, BufReader<R>>where R: Read,

pub fn new(reader: R, compression: Compression) -> Result<Self>

Creates a new DynReader from a reader, with the specified compression.

Errors

This function will return an error if it fails to create the zstd decoder.

pub fn new_inferred(reader: R) -> Result<Self>

Creates a new DynReader from a reader, inferring the compression. If reader also implements io::BufRead, it is better to use inferred_with_buffer().

Errors

This function will return an error if it is unable to read from reader or it fails to create the zstd decoder.

impl<'a, R> DynReader<'a, R>where R: BufRead,

pub fn with_buffer(reader: R, compression: Compression) -> Result<Self>

Creates a new DynReader from a buffered reader with the specified compression.

Errors

This function will return an error if it fails to create the zstd decoder.

pub fn inferred_with_buffer(reader: R) -> Result<Self>

Creates a new DynReader from a buffered reader, inferring the compression.

Errors

This function will return an error if it fails to read from reader or creating the zstd decoder fails.

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

Returns a mutable reference to the inner reader.

pub fn get_ref(&self) -> &R

Returns a reference to the inner reader.

impl<'a> DynReader<'a, BufReader<File>>

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Creates a new DynReader from the file at path.

Errors

This function will return an error if the file doesn’t exist, it is unable to determine the encoding of the file or it fails to parse the metadata.

Trait Implementations

impl<'a, R> Read for DynReader<'a, R>where R: BufRead,

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>

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

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

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

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

Read 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)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere 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.