Struct lzzzz::lz4f::WriteDecompressor

pub struct WriteDecompressor<'a, W: Write> { /* private fields */ }

The Write-based streaming decompressor.

Example

use lzzzz::lz4f::{compress_to_vec, WriteDecompressor};
use std::{fs::File, io::prelude::*};

let mut f = File::create("foo.txt")?;
let mut w = WriteDecompressor::new(&mut f)?;

let mut buf = Vec::new();
compress_to_vec(b"Hello world!", &mut buf, &Default::default())?;

w.write_all(&buf)?;

Implementations

impl<'a, W: Write> WriteDecompressor<'a, W>

pub fn new(writer: W) -> Result<Self>

Creates a new WriteDecompressor<W>.

pub fn set_dict<D>(&mut self, dict: D)

where D: Into<Cow<'a, [u8]>>,

Sets the dictionary.

pub fn frame_info(&self) -> Option<FrameInfo>

Returns FrameInfo if the frame header is already decoded. Otherwise, returns None.

pub fn decode_header_only(&mut self, flag: bool)

Sets the ‘header-only’ mode.

When the ‘header-only’ mode is enabled, the decompressor doesn’t consume the frame body and write() always returns Ok(0) if the frame header is already decoded.

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

Returns a mutable reference to the writer.

pub fn get_ref(&self) -> &W

Returns a shared reference to the writer.

pub fn into_inner(self) -> W

Returns ownership of the writer.

Trait Implementations

impl<W> Debug for WriteDecompressor<'_, W>

where W: Write + Debug,

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

Formats the value using the given formatter.

impl<W: Write> Write for WriteDecompressor<'_, 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.