ExCodecs.Compression.Lz4 (ex_codecs v0.1.0)

Copy Markdown View Source

LZ4 compression codec.

LZ4 is an extremely fast compression algorithm focused on speed. It provides compression at over 1 GB/s per core and decompression at multi-GB/s speeds.

LZ4 does not accept configuration options. It uses a fixed compression strategy optimized for speed.

Performance Characteristics

  • Extremely fast compression and decompression
  • Lower compression ratio compared to Zstd or Bzip2
  • Ideal for real-time and latency-sensitive applications

Examples

iex> {:ok, compressed} = ExCodecs.encode(:lz4, "hello world")
iex> {:ok, decompressed} = ExCodecs.decode(:lz4, compressed)
iex> decompressed
"hello world"

Summary

Functions

Returns codec metadata for the registry.

Decodes (decompresses) LZ4-compressed data.

Encodes (compresses) data using LZ4.

Functions

__codec_info__()

Returns codec metadata for the registry.

decode(data, opts)

Decodes (decompresses) LZ4-compressed data.

encode(data, opts)

Encodes (compresses) data using LZ4.

LZ4 does not accept configuration options.