ezstd

Zstd binding for Erlang

This binding is based on zstd v1.5.7. The build is pinned to an immutable commit SHA (ZSTD_SHA in build_deps.sh) rather than a mutable git tag, to protect against supply-chain attacks where a tag is re-pointed at a different commit upstream. To change the zstd version, update ZSTD_SHA (the # vX.Y.Z comment next to it is just for humans). You can find the commit a tag resolves to with:

git ls-remote https://github.com/facebook/zstd.git 'v1.5.7^{}'

API

Compress and decompress

Plaintext = <<"contentcontentcontentcontent">>,
Compressed = ezstd:compress(Plaintext, 1),
Plaintext = ezstd:decompress(Compressed).

Compress and decompress using dictionary

Dict = <<"content-dict">>,
CDict = ezstd:create_cdict(Dict, 1),
DDict = ezstd:create_ddict(Dict),
Plaintext = <<"contentcontentcontentcontent">>,
ContentCompressed = ezstd:compress_using_cdict(Plaintext, CDict),
Plaintext = ezstd:decompress_using_ddict(ContentCompressed, DDict).

Building on Windows

Linux and macOS build the NIF with make. Windows builds it with Zig, which brings its own C/C++ compiler and Windows headers, so zig on the PATH is the only requirement (no Visual Studio, no MSYS2). rebar.config runs build_win32.ps1 as the Windows compile hook; it fetches zstd at the same pinned commit and produces priv/ezstd_nif.dll.

Running tests

rebar3 ct