Struct compress::lz4::Encoder

pub struct Encoder<W> { /* fields omitted */ }

This structure is used to compress a stream of bytes using the LZ4 compression algorithm. This is a wrapper around an internal writer which bytes will be written to.

Methods

impl<W: Write> Encoder<W>

fn new(w: W) -> Encoder<W>

Creates a new encoder which will have its output written to the given output stream. The output stream can be re-acquired by calling finish()

NOTE: compression isn't actually implemented just yet, this is just a skeleton of a future implementation.

fn finish(self) -> (W, Result<()>)

This function is used to flag that this session of compression is done with. The stream is finished up (final bytes are written), and then the wrapped writer is returned.

Trait Implementations

impl<W: Write> Write for Encoder<W>

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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

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