Struct LzfseWriterBytes

pub struct LzfseWriterBytes<'a> { /* private fields */ }

LZFSE encoding byte writer.

Exposes, in part, a LZFSE encoder via the Write interface that encodes into an inner Vec. Due to the nature of LZFSE streams Write::flush has no effect, instead it is imperative that we call LzfseWriterBytes::finalize after use to complete the encoding process.

Instances are created using LzfseRingEncoder::writer_bytes.

Aborts

With limited system memory Vec may abort when attempting to allocate sufficient memory. This issue will be resolved in future releases when try_reserve() is stabilized.

Examples

use lzfse_rust::LzfseRingEncoder;
use std::io::{self, Write};

fn main() -> io::Result<()> {
    let mut encoder = LzfseRingEncoder::default();
    let inner = Vec::default();
    let mut writer = encoder.writer_bytes(inner);
    writer.write_all(b"test")?;
    // It is IMPERATIVE that the writer is finalized.
    let enc = writer.finalize()?;
    // "test" string encoded.
    assert_eq!(enc, &[0x62, 0x76, 0x78, 0x2d, 0x04, 0x00, 0x00, 0x00, 0x74, 0x65, 0x73, 0x74,
                      0x62, 0x76, 0x78, 0x24]);
    Ok(())
}

Implementations

impl<'a> LzfseWriterBytes<'a>

pub fn finalize(self) -> Result<Vec<u8>>

Finalize the encoding process. Failure to finalize will likely result in a truncated output.

Trait Implementations

impl<'a> Debug for LzfseWriterBytes<'a>

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

Formats the value using the given formatter.

impl<'a> Write for LzfseWriterBytes<'a>

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

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

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

Flushes 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, args: 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.