Struct flate2::GzBuilder

pub struct GzBuilder { /* fields omitted */ }

A builder structure to create a new gzip Encoder.

This structure controls header configuration options such as the filename.

Examples

use std::io::prelude::*;
use std::fs::File;
use flate2::GzBuilder;
use flate2::Compression;

// GzBuilder opens a file and writes a sample string using GzBuilder pattern

let f = File::create("examples/hello_world.gz")?;
let mut gz = GzBuilder::new()
                .filename("hello_world.txt")
                .comment("test file, please delete")
                .write(f, Compression::default());
gz.write_all(b"hello world")?;
gz.finish()?;

Methods

impl GzBuilder

pub fn new() -> GzBuilder

Create a new blank builder with no header by default.

pub fn mtime(self, mtime: u32) -> GzBuilder

Configure the mtime field in the gzip header.

pub fn operating_system(self, os: u8) -> GzBuilder

Configure the operating_system field in the gzip header.

pub fn extra<T: Into<Vec<u8>>>(self, extra: T) -> GzBuilder

Configure the extra field in the gzip header.

pub fn filename<T: Into<Vec<u8>>>(self, filename: T) -> GzBuilder

Configure the filename field in the gzip header.

Panics

Panics if the filename slice contains a zero.

pub fn comment<T: Into<Vec<u8>>>(self, comment: T) -> GzBuilder

Configure the comment field in the gzip header.

Panics

Panics if the comment slice contains a zero.

Important traits for GzEncoder<R>

impl<R: Read + Write> Read for GzEncoder<R>impl<W: Write> Write for GzEncoder<W>

pub fn write<W: Write>(self, w: W, lvl: Compression) -> GzEncoder<W>

Consume this builder, creating a writer encoder in the process.

The data written to the returned encoder will be compressed and then written out to the supplied parameter w.

Important traits for GzEncoder<R>

impl<R: Read> Read for GzEncoder<R>impl<R: Read + Write> Write for GzEncoder<R>

pub fn read<R: Read>(self, r: R, lvl: Compression) -> GzEncoder<R>

Consume this builder, creating a reader encoder in the process.

Data read from the returned encoder will be the compressed version of the data read from the given reader.

Important traits for GzEncoder<R>

impl<R: BufRead> Read for GzEncoder<R>impl<R: BufRead + Write> Write for GzEncoder<R>

pub fn buf_read<R>(self, r: R, lvl: Compression) -> GzEncoder<R> where
    R: BufRead, 

Consume this builder, creating a reader encoder in the process.

Data read from the returned encoder will be the compressed version of the data read from the given reader.

Trait Implementations

impl Debug for GzBuilder

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

Formats the value using the given formatter.