lz4compress - Real Function Reference

lz4compress(data: string): string

Aliases

crypt.lz4compress
crypt.lz4.compress
lz4.compress

Arguments

string

required

Lua string bytes passed to LZ4 block compression.

Returns

string

Raw compressed bytes returned as a Lua string. The original size is not stored in the output.

Example

Compress Lua string bytes and restore them by passing the original size.

local source = string.rep("Real Docs ", 100)
local compressed = lz4compress(source)
local restored = lz4decompress(compressed, #source)

print(#source, #compressed, restored == source)