Struct Writer 

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

Available on crate feature std only.

Compresses while writing to a destination.

flush writes a sync point (everything so far becomes decodable) and flushes the destination; finish ends the stream and returns the destination. Dropping a writer without finish tries to end the stream and ignores errors, as a drop cannot report them: call finish.

Examples

use std::io::Write;

use compress_lib::{Format, Level, deflate, io::Writer};

let mut w = Writer::new(Vec::new(), Format::Raw, Level::FAST);
w.write_all(b"written")?;
assert_eq!(deflate::decompress(&w.finish()?).unwrap(), b"written");

Implementations

impl<W: Write> Writer<W>

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

Writes format at level to inner.

Examples

let w = compress_lib::io::Writer::new(Vec::new(), compress_lib::Format::Gzip, compress_lib::Level::FAST);

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

Ends the stream and returns the destination.

Errors

Errors of the destination.

Examples

use compress_lib::{Format, Level, io::Writer};

let packed = Writer::new(Vec::new(), Format::Zlib, Level::DEFAULT).finish()?;
assert_eq!(compress_lib::zlib::decompress(&packed).unwrap(), b"");

Trait Implementations

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

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

Formats the value using the given formatter.

impl<W: Write> Drop for Writer<W>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<W: Write> Write for Writer<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.