https://github.com/whatyouhide/nimble_lz4
LZ4 compression for Elixir using Rust NIFs. 🗜
https://github.com/whatyouhide/nimble_lz4
compression elixir elixir-lang elixir-library low-level lz4 rustler rustler-precompiled
Last synced: 7 months ago
JSON representation
LZ4 compression for Elixir using Rust NIFs. 🗜
- Host: GitHub
- URL: https://github.com/whatyouhide/nimble_lz4
- Owner: whatyouhide
- License: apache-2.0
- Created: 2022-05-19T18:37:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T07:22:27.000Z (10 months ago)
- Last Synced: 2025-03-31T09:05:11.941Z (7 months ago)
- Topics: compression, elixir, elixir-lang, elixir-library, low-level, lz4, rustler, rustler-precompiled
- Language: Elixir
- Homepage: https://github.com/lz4/lz4
- Size: 50.8 KB
- Stars: 29
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NimbleLZ4 🗜️
> [LZ4] compression library for Elixir that uses Rust NIFs.
## Installation
Add this to your dependencies in `mix.exs`.
```elixir
defp deps do
[
# ...,
{:nimble_lz4, "~> 0.1.0"}
]
end
```
NimbleLZ4 requires OTP 23+ and Elixir 1.11+.
### Native Code
NimbleLZ4 uses [RustlerPrecompiled] to build precompiled version of the
necessary Rust NIFs bindings for a variety of platforms, NIF versions, and
operating systems. RustlerPrecompiled should automatically download the correct
version of the bindings when compiling NimbleLZ4 as a dependency of your
application.
You can **force compilation** of the native code by setting the
`NIMBLELZ4_FORCE_BUILD` environment variable to `true`:
```shell
NIMBLELZ4_FORCE_BUILD=true mix deps.compile
```
## Usage
You can compress and decompress data.
[Block format](https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md):
```elixir
iex> uncompressed = :crypto.strong_rand_bytes(10)
iex> compressed = NimbleLZ4.compress(uncompressed)
iex> {:ok, ^uncompressed} = NimbleLZ4.decompress(compressed, _uncompressed_size = 10)
true
```
[Frame format](https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md) ([self-contained](https://android.googlesource.com/platform/external/lz4/+/HEAD/doc/lz4_Block_format.md#metadata)):
```elixir
iex> uncompressed = :crypto.strong_rand_bytes(10_000)
iex> compressed = NimbleLZ4.compress_frame(uncompressed)
iex> {:ok, ^uncompressed} = NimbleLZ4.decompress_frame(compressed)
true
```
[LZ4]: https://github.com/lz4/lz4
[RustlerPrecompiled]: https://github.com/philss/rustler_precompiled