Zlib compression API documentation

Version: alpha

FUNCTIONS
zlib.deflate() Deflate (compress) a buffer
zlib.inflate() Inflate (decompress) a buffer

Functions

zlib.deflate()

zlib.deflate(buf)

A lua error is raised is on error

PARAMETERS

buf string buffer to deflate

RETURNS

buf string deflated buffer

EXAMPLES

local data = "This is a string with uncompressed data."
local compressed_data = zlib.deflate(data)
local s = ""
for c in string.gmatch(compressed_data, ".") do
    s = s .. '\\' .. string.byte(c)
end
print(s) --> \120\94\11\201\200\44\86\0\162\68\133\226\146\162 ...

zlib.inflate()

zlib.inflate(buf)

A lua error is raised is on error

PARAMETERS

buf string buffer to inflate

RETURNS

buf string inflated buffer

EXAMPLES

local data = "\120\94\11\201\200\44\86\0\162\68\133\226\146\162\204\188\116\133\242\204\146\12\133\210\188\228\252\220\130\162\212\226\226\212\20\133\148\196\146\68\61\0\44\67\14\201"
local uncompressed_data = zlib.inflate(data)
print(uncompressed_data) --> This is a string with uncompressed data.