Struct snap::read::FrameEncoder

pub struct FrameEncoder<R: Read> { /* private fields */ }

A reader for compressing data using snappy as it is read.

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

Usually you’ll want read::FrameDecoder (for decompressing while reading) or write::FrameEncoder (for compressing while writing) instead.

Unlike FrameDecoder, this will attempt to make large reads roughly equivalent to the size of a single Snappy block. Therefore, callers may not benefit from using a buffered reader.

Implementations

impl<R: Read> FrameEncoder<R>

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

Create a new reader for streaming Snappy compression.

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader in this decoder.

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

Gets a mutable reference to the underlying reader in this decoder.

Note that mutation of the stream may result in surprising results if this encoder is continued to be used.

Trait Implementations

impl<R: Debug + Read> Debug for FrameEncoder<R>

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

Formats the value using the given formatter.

impl<R: Read> Read for FrameEncoder<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.

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