ZarrNET.GzipCodec Class Reference

Gzip bytes-to-bytes codec. Wraps System.IO.Compression — no native dependencies. Configuration mirrors the zarr.json "gzip" codec configuration object. More...

Inheritance diagram for ZarrNET.GzipCodec:

Public Member Functions
	GzipCodec (int level=6)
async Task< byte[]>	DecodeAsync (byte[] input, CancellationToken ct=default)
	Decodes bytes produced by the previous codec step.
async Task< byte[]>	EncodeAsync (byte[] input, CancellationToken ct=default)
	Encodes bytes for the next codec step.
Public Member Functions inherited from ZarrNET.IZarrCodec

Properties
string	Name [get]
	Codec name as it appears in zarr.json (e.g. "gzip", "zstd", "bytes").
Properties inherited from ZarrNET.IZarrCodec

Detailed Description

Gzip bytes-to-bytes codec. Wraps System.IO.Compression — no native dependencies. Configuration mirrors the zarr.json "gzip" codec configuration object.

Constructor & Destructor Documentation

GzipCodec()

ZarrNET.GzipCodec.GzipCodec

(

int

level = 6

)

    {
        _compressionLevel = level switch
        {
            0         => CompressionLevel.NoCompression,
            1         => CompressionLevel.Fastest,
            >= 7      => CompressionLevel.SmallestSize,
            _         => CompressionLevel.Optimal
        };
    }

Member Function Documentation

DecodeAsync()

async Task< byte[]> ZarrNET.GzipCodec.DecodeAsync	(	byte[]	input,
		CancellationToken	ct = default )

Decodes bytes produced by the previous codec step.

Implements ZarrNET.IZarrCodec.

    {
        await using var inputStream  = new MemoryStream(input);
        await using var gzipStream   = new GZipStream(inputStream, CompressionMode.Decompress);
        await using var outputStream = new MemoryStream();
 
        await gzipStream.CopyToAsync(outputStream, ct).ConfigureAwait(false);
 
        return outputStream.ToArray();
    }

EncodeAsync()

async Task< byte[]> ZarrNET.GzipCodec.EncodeAsync	(	byte[]	input,
		CancellationToken	ct = default )

Encodes bytes for the next codec step.

Implements ZarrNET.IZarrCodec.

    {
        await using var outputStream = new MemoryStream();
 
        await using (var gzipStream = new GZipStream(outputStream, _compressionLevel, leaveOpen: true))
        {
            await gzipStream.WriteAsync(input, ct).ConfigureAwait(false);
        }
 
        return outputStream.ToArray();
    }

Property Documentation

Name

string ZarrNET.GzipCodec.Name

get

Codec name as it appears in zarr.json (e.g. "gzip", "zstd", "bytes").

Implements ZarrNET.IZarrCodec.

---

The documentation for this class was generated from the following file:

• ZarrNET/GzipCodec.cs