Struct compress::bwt::Encoder

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

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

Implementations

impl<W: Write> Encoder<W>

pub fn new(w: W, block_size: usize) -> 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() 'block_size' is idealy as big as your input, unless you know for sure that the input consists of multiple parts of different nature. Often set as 4Mb.

pub 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 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 Writeer 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

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