Lua

GZip Create / Extract .gz File

See more Gzip Examples

Demonstrates how to compress a file to create a .gz (GZip) file.

Note: The .gz file format is a compressed file format. It contains a single file. The .gz file format is not an archive format (i.e. it does not contain a collection of files/directories such as with the .zip, .rar, or .tar file formats). GZip is often combined with TAR to create a .tgz (or .tar.gz).

Note: It is possible for a .gz to contain more than one file, but this is very uncommon.

Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local gzip = chilkat.Gzip.new()

-- File-to-file GZip:
-- Compress "hamlet.xml" to create "hamlet.xml.gz";
local success = gzip:compress_file("hamlet.xml", "hamlet.xml.gz")
if not success then
    print(gzip.last_error_text)
    return
end

-- File-to-file ungzip
-- Decompress "hamlet.xml.gz" to create "hamletOut.xml";
success = gzip:uncompress_file("hamlet.xml.gz", "hamletOut.xml")
if not success then
    print(gzip.last_error_text)
    return
end

-- File-to-string ungzip
-- Decompress the contents of a .gz directly to a string variable:
-- The 2nd argument indicates the charset of the character
-- data after it is decompressed.
local xmlStr = gzip:uncompress_file_to_string("hamlet.xml.gz", "utf-8")
if not success then
    print(gzip.last_error_text)
    return
end

print(xmlStr)

-- The Chilkat GZip API provides much more flexibility than shown
-- here.  See the reference documentation at
-- http://www.chilkatsoft.com/refdoc for more information.