Struct snap::write::FrameEncoder

pub struct FrameEncoder<W: Write> { /* private fields */ }

A writer for compressing a Snappy stream.

This FrameEncoder wraps any other writer that implements io::Write. Bytes written to this writer are compressed using the Snappy frame format (file extension sz, MIME type application/x-snappy-framed).

Writes are buffered automatically, so there’s no need to wrap the given writer in a std::io::BufWriter.

The writer will be flushed automatically when it is dropped. If an error occurs, it is ignored.

Implementations

impl<W: Write> FrameEncoder<W>

pub fn new(wtr: W) -> FrameEncoder<W>

Create a new writer for streaming Snappy compression.

pub fn into_inner(self) -> Result<W, IntoInnerError<FrameEncoder<W>>>

Returns the underlying stream, consuming and flushing this writer.

If flushing the writer caused an error, then an IntoInnerError is returned, which contains both the writer and the original writer.

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer in this encoder.

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

Gets a reference to the underlying writer in this encoder.

Note that mutating the output/input state of the stream may corrupt this encoder, so care must be taken when using this method.

Trait Implementations

impl<W: Debug + Write> Debug for FrameEncoder<W>

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

Formats the value using the given formatter.

impl<W: Write> Drop for FrameEncoder<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Write> Write for FrameEncoder<W>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.