Struct snap::Reader

pub struct Reader<R: Read> { /* fields omitted */ }

A reader for decompressing a Snappy stream.

This Reader wraps any other reader that implements io::Read. Bytes read from this reader are decompressed using the Snappy frame format (file extension sz, MIME type application/x-snappy-framed).

This reader can potentially make many small reads from the underlying stream depending on its format, therefore, passing in a buffered reader may be beneficial.

Methods

impl<R: Read> Reader<R>

Important traits for Reader<R>

impl<R: Read> Read for Reader<R>

pub fn new(rdr: R) -> Reader<R>

Create a new reader for streaming Snappy decompression.

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader in this decoder.

Trait Implementations

impl<R: Read> Read for Reader<R>

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.

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.

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 by_ref(&mut self) -> &mut Self

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chars(self) -> Chars<Self>

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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

Creates an adaptor which will chain this stream with another.

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

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