Struct GzipStreamEncoder 

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

Streaming GZIP encoder that implements Write.

Maintains a single GZIP stream with a persistent Deflater and running CRC-32. Flush methods (sync_flush, full_flush, partial_flush) emit DEFLATE blocks within the same stream.

Important: you must call finish to write the GZIP trailer. Dropping the encoder without calling finish will produce an incomplete GZIP stream.

Implementations

impl<W: Write> GzipStreamEncoder<W>

pub fn new(writer: W, level: u8) -> Self

Create a new streaming GZIP encoder wrapping writer.

The level parameter controls the DEFLATE compression level (0-9).

pub fn with_block_size(self, block_size: usize) -> Self

Set the block size used for incremental flushing.

When the internal buffer reaches this many bytes it is automatically flushed via sync_flush.

pub fn sync_flush(&mut self) -> Result<()>

Drain the internal buffer through the deflater using a sync flush.

A sync flush emits a compressed block followed by an empty stored block (0x00 0x00 0xFF 0xFF), which byte-aligns the stream and allows a decoder to decode all data fed so far.

pub fn full_flush(&mut self) -> Result<()>

Full flush: same as sync flush, then reset the LZ77 state.

After a full flush the compressor state is reset so subsequent data can be decompressed independently (given knowledge of the block boundary).

pub fn partial_flush(&mut self) -> Result<()>

Partial flush: emit a compressed block without the sync marker.

The block is flushed to a byte boundary but no empty stored block is appended. This produces slightly smaller output than sync flush but the decoder cannot determine a safe decompression boundary.

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

Finish compression and return the inner writer.

This must be called to write the GZIP trailer (CRC-32 + ISIZE).

Errors

Returns an io::Error if compression or writing to the inner writer fails.

pub fn buffered_bytes(&self) -> usize

Returns the number of uncompressed bytes currently buffered.

pub fn is_finished(&self) -> bool

Returns true if finish has already been called.

Trait Implementations

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