Question 1

How to compress a file using LZ4 in C#?

Accepted Answer

Use the LZ4Stream.Encode method to wrap a file stream. For example, LZ4Stream.Encode(File.Create("output.lz4")) compresses data written to it. Ensure you install the K4os.Compression.LZ4.Streams NuGet package.

Question 2

What's the difference between LZ4 and LZ4HC in this library?

Accepted Answer

LZ4HC refers to high-compression levels (L03_HC to L09_HC) that trade speed for better ratios, while standard LZ4 (L00_FAST) prioritizes speed. The library offers multiple levels from FAST to MAX for balancing needs.

Question 3

K4os.Compression.LZ4 vs System.IO.Compression for .NET?

Accepted Answer

K4os.Compression.LZ4 is much faster but provides lower compression ratios compared to algorithms like Deflate in System.IO.Compression. It's best for latency-sensitive apps, while System.IO.Compression suits storage where size matters more.

Question 4

How to decompress a block without knowing the original size?

Accepted Answer

Use LZ4Pickler for small chunks, as it encodes the original length internally. For streams, LZ4Stream.Decode handles it automatically, but block decompression requires storing the size separately or using safe estimates.

Question 5

Is this library compatible with Unity and IL2CPP?

Accepted Answer

Yes, it supports .NET Standard and can be used in Unity. However, on ARMv7, set LZ4Codec.Enforce32 = true to avoid unaligned memory access issues, especially with IL2CPP builds.

Question 6

What are the performance benefits of memory pooling?

Accepted Answer

Memory pooling reduces allocations and GC pressure, improving speed for repetitive operations. But it pins memory, which might be problematic for long-lived streams; adjust PinnedMemory.MaxPooledSize to control or disable it.

Question 7

How to use the new LZ4Frame API for better performance?

Accepted Answer

Use LZ4Frame.Decode or Encode with spans or buffer writers for faster, allocation-efficient operations compared to streams. For example, LZ4Frame.Decode(encodedSpan, new ArrayBufferWriter<byte>()) reduces memory overhead.

lz4net

What is lz4net?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions