Submodule compress.lz4
The compress.lz4 submodule provides the ability to compress and decompress data using the lz4 algorithm.
You can use the lz4 compressor as follows:
Create a compressor instance using the compress.lz4.new() function:
local lz4_compressor = require('compress.lz4').new() -- or -- local lz4_compressor = require('compress').lz4.new()
Optionally, you can pass compression options (lz4_opts) specific for
lz4:local lz4_compressor = require('compress.lz4').new({ acceleration = 1000, decompress_buffer_size = 2097152 })
To compress the specified data, use the compress() method:
compressed_data = lz4_compressor:compress('Hello world!')
To decompress data, call decompress():
decompressed_data = lz4_compressor:decompress(compressed_data)
| Functions | |
| compress.lz4.new() | Create a lz4 compressor instance. |
| Objects | |
| lz4_compressor | A lz4 compressor instance. |
| lz4_opts | Configuration options of the lz4 compressor. |
-
compress.lz4.new([lz4_opts])¶ Create a
lz4compressor instance.Parameters: Return: a new
lz4compressor instance (see lz4_compressor)Rtype: userdata
Example
local lz4_compressor = require('compress.lz4').new({ acceleration = 1000, decompress_buffer_size = 2097152 })
-
object
lz4_compressor¶ A compressor instance that exposes the API for compressing and decompressing data using the
lz4algorithm. To create thelz4compressor, call compress.lz4.new().
-
object
lz4_opts¶ Configuration options of the lz4_compressor. These options can be passed to the compress.lz4.new() function.
Example
local lz4_compressor = require('compress.lz4').new({ acceleration = 1000, decompress_buffer_size = 2097152 })
-
lz4_opts.acceleration¶ Specifies the acceleration factor that enables you to adjust the compression ratio and speed. The higher acceleration factor increases the compression speed but decreases the compression ratio.
Default: 1Maximum: 65537Minimum: 1
-
lz4_opts.decompress_buffer_size¶ Specifies the decompress buffer size (in bytes). If the size of decompressed data is larger than this value, the compressor returns an error on decompression.
Default: 1048576
-