Submodule compress.zstd
The compress.zstd submodule provides the ability to compress and decompress data using the zstd algorithm.
You can use the zstd compressor as follows:
Create a compressor instance using the compress.zstd.new() function:
local zstd_compressor = require('compress.zstd').new() -- or -- local zstd_compressor = require('compress').zstd.new()
Optionally, you can pass compression options (zstd_opts) specific for
zstd:local zstd_compressor = require('compress.zstd').new({ level = 5 })
To compress the specified data, use the compress() method:
compressed_data = zstd_compressor:compress('Hello world!')
To decompress data, call decompress():
decompressed_data = zstd_compressor:decompress(compressed_data)
| Functions | |
| compress.zstd.new() | Create a zstd compressor instance. |
| Objects | |
| zstd_compressor | A zstd compressor instance. |
| zstd_opts | Configuration options of the zstd compressor. |
-
compress.zstd.new([zstd_opts])¶ Create a
zstdcompressor instance.Параметры: Return: a new
zstdcompressor instance (see zstd_compressor)Rtype: userdata
Example
local zstd_compressor = require('compress.zstd').new({ level = 5 })
-
object
zstd_compressor¶ A compressor instance that exposes the API for compressing and decompressing data using the
zstdalgorithm. To create thezstdcompressor, call compress.zstd.new().
-
object
zstd_opts¶ Configuration options of the zstd_compressor. These options can be passed to the compress.zstd.new() function.
Example
local zstd_compressor = require('compress.zstd').new({ level = 5 })
-
zstd_opts.level¶ Specifies the
zstdcompression level that enables you to adjust the compression ratio and speed. The lower level improves the compression speed at the cost of compression ratio. For example, you can use level 1 if speed is most important and level 22 if size is most important.Default: 3Minimum: -131072Maximum: 22Примечание
Assigning 0 to
levelresets its value to the default (3).
-