Struct DecodeWriter 

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

Available on crate feature std only.

Decompresses while writing: compressed data written in comes out plain in inner.

Bytes after the end of the stream are refused (InvalidData). finish checks that the stream was complete.

Examples

use std::io::Write;

use compress_lib::{Format, gzip, io::DecodeWriter};

let mut w = DecodeWriter::new(Vec::new(), Format::Gzip);
w.write_all(&gzip::compress(b"decoded on write"))?;
assert_eq!(w.finish()?, b"decoded on write");

Implementations

impl<W: Write> DecodeWriter<W>

pub fn new(inner: W, format: Format) -> Self

Decodes format into inner with the default limits.

Examples

let w = compress_lib::io::DecodeWriter::new(Vec::new(), compress_lib::Format::Zlib);

pub fn with_limits(self, limits: Limits) -> Self

Sets the limits checked while decoding.

Examples

use compress_lib::{Format, Limits, io::DecodeWriter};

let w = DecodeWriter::new(Vec::new(), Format::Zlib).with_limits(Limits::new().with_max_output(1 << 20));

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

Checks that the stream ended and returns the destination.

Errors

UnexpectedEof when the stream is incomplete; errors of the destination.

Examples

use std::io::Write;

use compress_lib::{Format, zlib, io::DecodeWriter};

let packed = zlib::compress(b"whole");
let mut w = DecodeWriter::new(Vec::new(), Format::Zlib);
w.write_all(&packed[..packed.len() - 2])?;
assert_eq!(w.finish().unwrap_err().kind(), std::io::ErrorKind::UnexpectedEof);

Trait Implementations

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

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

Formats the value using the given formatter.

impl<W: Write> Write for DecodeWriter<W>

fn write(&mut self, data: &[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.