Rust

Compress a File to Gzip with Custom Metadata

See more Gzip Examples

This example demonstrates how to use the CompressFile method to create a Gzip (.gz) file while customizing the metadata embedded in the Gzip header.

Before compression, several properties are set:

• Comment: Adds a descriptive comment to the Gzip file.
• Filename: Specifies the filename to embed in the Gzip data, which may be used by extraction tools as the default output name.
• CompressionLevel: Controls the tradeoff between compression ratio and speed (set to maximum in this example).
• LastModStr: Sets the last-modified timestamp using an RFC 822 formatted date string.

After setting these properties, the input file is compressed and written to a .gz file. This approach allows you to embed meaningful metadata along with the compressed data.

Rust

// This example demonstrates how to compress a file to Gzip format
// while setting custom metadata such as comment, filename,
// compression level, and last-modified date.

let gzip = chilkat::Gzip::new();

// Set custom Gzip properties:
gzip.set_comment("Example Gzip file created with Chilkat");
gzip.set_filename("custom_name.txt");
gzip.set_compression_level(9);
gzip.set_last_mod_str("Wed, 1 Apr 2025 12:45:26 -0500");

// The file to be compressed:
let input_file = "example.txt".to_string();
let output_file = "example.txt.gz".to_string();

// Compress the file:
if gzip.compress_file(&input_file, &output_file).is_err() {
    println!("{}", gzip.last_error_text());
    return;
}

println!("Compression successful.");
println!("Gzip file created: {}", output_file);