Enum SyncCompressWriter 

pub enum SyncCompressWriter<W: Write> {
    Plain(W),
    Gzip(GzEncoder<W>),
    Zstd(Encoder<'static, W>),
}

Available on crate feature compression only.

A sync compressing writer that retains the concrete encoder so its finalisation error can be captured, unlike the Box<dyn Write> returned by wrap_sync_writer (#78/#41).

Call finish when done: it writes the codec’s trailer (gzip’s 8-byte CRC/length footer, zstd’s frame epilogue) and returns the inner writer, surfacing any I/O error instead of swallowing it on drop. If the value is dropped without finish, the zstd variant does not emit its epilogue — always finish for a valid stream.

Variants

Plain(W)

Gzip(GzEncoder<W>)

Zstd(Encoder<'static, W>)

Implementations

impl<W: Write> SyncCompressWriter<W>

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

Finalise the stream and return the inner writer, propagating any trailer-write error.

Trait Implementations

impl<W: Write> Write for SyncCompressWriter<W>

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.