IronCompress 1.5.1

dotnet add package IronCompress --version 1.5.1
NuGet\Install-Package IronCompress -Version 1.5.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IronCompress" Version="1.5.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add IronCompress --version 1.5.1
#r "nuget: IronCompress, 1.5.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install IronCompress as a Cake Addin
#addin nuget:?package=IronCompress&version=1.5.1

// Install IronCompress as a Cake Tool
#tool nuget:?package=IronCompress&version=1.5.1

IronCompress

NuGet

<img src="icon.png" width=80 height=80 align="left"/> C++ compression methods joined together in one native library, cross-compiled for multiple architectures and exposed as a .NET library. .NET has built-in support for Gzip and Brotli (which is what this library is using) but other compression methods are either available only as native libraries hard (impossible for some) to consume, or ill-ported C# alternatives. In fact, I myself wrote one of them. Using native, original implementations is the way to go if you want to keep performance, security, and features up to date.

The library supports the following formats:

And following architectures:

Format Managed Windows Linux Mac OSX ◀️ OS<br />Arch 🔽
Snappy x32
x64
ARM64
Zstd x32
x64
ARM64
Gzip ✅<br /><sup>part of .NET</sup>
Brotli ✅<br /><sup>except on .NET Standard 2.0</sup> x32
x64
ARM64
LZO x32
x64
ARM64
LZ4 x32
x64
ARM64

I periodically update to the latest binaries. All the binaries are compiled from C/C++ source with CMake for major systems i.e. Linux, Windows and Mac OSX. They are then wrapped safely with a .NET interface.

Logic

Although managed versions are available, they will be only used as a fallback when native library is not available, because native libraries are faster and more up to date with latest advancements.

You can check which version was used by reading IronCompressResult.NativeUsed flag.

Using

This library only compresses buffers. It may work with streams in the future, but I am currently only interested in buffers. Essentially, you pass ReadOnlySpan<byte> as an input, and receive Span<T> as an output in the most efficient way.

Here is an example of how to compress buffer with snappy codec:

using IronCompress;	// root namespace

// Construct library entry point and optionally pass an implementation of ArrayPool.
// I will pass default shared pool here.
var iron = new Iron();

byte[] input = ...;
using(IronCompressResult compressed = iron.Compress(Codec.Snappy, input.AsSpan())) {
    // ... use data
}

Compressand Decompress methods actually return a Result class which wraps byte array of compression or decompression operation. You can access the underlying result by calling to .AsSpan() method inside the result. On dispose, Result makes sure the underlying memory is freed up - if pooling was used, it will be returned back to the pool.

To decompress:

using (IronCompressResult uncompressed = iron.Decompress(Codec.Snappy, compressed, input.Length)) {
	// ... use data
}

As with compression, this returns Result with decompressed data. It's worth nothing one important difference - decompression needs the length of output buffer specified as third parameter (input.Length). Although some decompressors can guess uncompressed length more or less correct, the others won't know it beforehand. In reality this problem is solved by using a framing format that adds metadata about resulting length, however many compression formats do not define that and consider compressed packets to be implementation specific.

You will need more or less recent C++ compiler, CMake and .NET SDK 6 to build the code.

Building

See workflow file for building instructions.

Hint: To develop managed only code locally you can download the latest artifact from Actions output and put it into native/ubin so you have binaries for all platforms.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on IronCompress:

Package Downloads
Parquet.Net

Fully managed Apache Parquet implementation.

Elsa.Workflows.Management

Provides workflow management functionality.

Workspace.Parquet.Net

Fully managed Apache Parquet implementation.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on IronCompress:

Repository Stars
aloneguid/parquet-dotnet
Fully managed Apache Parquet implementation
Version Downloads Last updated
1.5.1 658,384 8/3/2023
1.5.0 153 8/3/2023
1.4.0 373,387 5/10/2023
1.3.0 488,020 1/27/2023
1.2.8 283 1/26/2023
1.2.7 8,236 1/23/2023
1.2.6 11,067 1/11/2023
1.2.5 76,840 12/21/2022
1.2.4 22,367 11/24/2022
1.2.3 115,253 11/10/2022
1.2.2 327 11/10/2022
1.2.0 349 11/9/2022
1.1.5 142,305 10/13/2022
1.1.4 379 10/12/2022
1.1.3 384 10/12/2022
1.1.2 363 10/12/2022
1.1.1 355 10/12/2022
1.1.0 374 10/11/2022
1.0.0 475 9/26/2022
1.0.0-preview-03 158 9/26/2022
1.0.0-preview-02 235 1/12/2022
1.0.0-preview-01 391 1/12/2022