Struct deflate::write::GzEncoder

pub struct GzEncoder<W: Write> { /* fields omitted */ }

A Gzip encoder/compressor.

A struct implementing a Write interface that takes arbitrary data and compresses it to the provided writer using DEFLATE compression with Gzip headers and trailers.

Examples

use std::io::Write;

use deflate::Compression;
use deflate::write::GzEncoder;

let data = b"This is some test data";
let mut encoder = GzEncoder::new(Vec::new(), Compression::Default);
encoder.write_all(data)?;
let compressed_data = encoder.finish()?;

Implementations

impl<W: Write> GzEncoder<W>

pub fn new<O: Into<CompressionOptions>>(writer: W, options: O) -> GzEncoder<W>

Create a new GzEncoder writing deflate-compressed data to the underlying writer when written to, wrapped in a gzip header and trailer. The header details will be blank.

pub fn from_builder<O: Into<CompressionOptions>>(
    builder: GzBuilder,
    writer: W,
    options: O
) -> GzEncoder<W>

Create a new GzEncoder from the provided GzBuilder. This allows customising the details of the header, such as the filename and comment fields.

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

Encode all pending data to the contained writer, consume this GzEncoder, and return the contained writer if writing succeeds.

pub fn reset(&mut self, writer: W) -> Result<W>

Resets the encoder (except the compression options), replacing the current writer with a new one, returning the old one. (Using a blank header).

pub fn reset_with_builder(&mut self, writer: W, builder: GzBuilder) -> Result<W>

Resets the encoder (except the compression options), replacing the current writer with a new one, returning the old one, and using the provided GzBuilder to create the header.

pub fn checksum(&self) -> u32

Get the crc32 checksum of the data consumed so far.

Trait Implementations

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

fn drop(&mut self)

When the encoder is dropped, output the rest of the data.

WARNING: This may silently fail if writing fails, so using this to finish encoding for writers where writing might fail is not recommended, for that call finish() instead.

impl<W: Write> Write for GzEncoder<W>

fn flush(&mut self) -> Result<()>

Flush the encoder.

This will flush the encoder, emulating the Sync flush method from Zlib. This essentially finishes the current block, and sends an additional empty stored block to the writer.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

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

Creates a “by reference” adapter for this instance of Write.