ZlibCore 2.0.1

zlib.net

Managed version of the ZLIB compression library ported to .NET Core

This port is based on the 100% managed version of the library from ComponentAce.

Installation

dotnet add package ZlibCore

Versions up to 1.1.0 were published under the misspelled ID zlib.net-mutliplatform. From 2.0.0 the package is ZlibCore.

Targets netstandard2.0, netstandard2.1 and net8.0. The Span/Memory overloads and DisposeAsync are available on netstandard2.1 and net8.0.

Usage

using ComponentAce.Compression.Libs.zlib;

// Compress
var compressed = new MemoryStream();
using (var zout = new ZOutputStream(compressed, zlibConst.Z_DEFAULT_COMPRESSION))
{
    zout.Write(data, 0, data.Length);
    zout.Finish();
    result = compressed.ToArray(); // ZOutputStream disposes the target stream, so read it before disposing
}

// Decompress
var decompressed = new MemoryStream();
using (var zout = new ZOutputStream(decompressed))
{
    zout.Write(compressedData, 0, compressedData.Length);
    zout.Finish();
    result = decompressed.ToArray();
}

// Async (netstandard2.1 / net8.0): DisposeAsync finishes the stream without blocking on the target
await using (var zout = new ZOutputStream(target, zlibConst.Z_DEFAULT_COMPRESSION, leaveOpen: true))
{
    await zout.WriteAsync(data);
}

await using (var zin = new ZInputStream(source))
{
    int read = await zin.ReadAsync(buffer.AsMemory());
}

Migrating from 1.x

Switch the package reference to ZlibCore. The namespace and assembly name are unchanged. Breaking changes:

• ZInputStream is now a Stream rather than a BinaryReader. Read(byte[], int, int) returns decompressed data (previously it returned raw bytes from the underlying stream) and returns 0 at the end, like any other stream. ReadByte() replaces the no-argument Read(), and ReadAsync is supported. Compress mode (new ZInputStream(stream, level)) now works without setting FlushMode.
• Truncated compressed input now throws ZStreamException instead of silently ending the stream.
• ZOutputStream.Read, Seek, SetLength, Length and Position throw NotSupportedException instead of returning 0.
• ZOutputStream.finish()/end() and ZInputStream.read()/skip() are renamed Finish()/End()/Read(); the old names still work but are marked [Obsolete].
• SupportClass and Deflate were never meant to be public and are now internal.
• New: both streams take a leaveOpen argument to keep the underlying stream open on dispose.

Building

dotnet test
dotnet pack zlib.net.csproj -c Release