ZarrNET.ZstdCodec Class Reference

Zstandard bytes-to-bytes codec. Uses ZstdSharp (managed wrapper around the native zstd library, available as a NuGet package). NuGet: ZstdSharp.Port (pure managed port, no native deps) More...

Inheritance diagram for ZarrNET.ZstdCodec:

Public Member Functions
	ZstdCodec (int level=3)
	Parameters level Compression level 0–22. Default 3 matches zstd's default.
Task< byte[]>	DecodeAsync (byte[] input, CancellationToken ct=default)
	Decodes bytes produced by the previous codec step.
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

Zstandard bytes-to-bytes codec. Uses ZstdSharp (managed wrapper around the native zstd library, available as a NuGet package). NuGet: ZstdSharp.Port (pure managed port, no native deps)

Constructor & Destructor Documentation

ZstdCodec()

ZarrNET.ZstdCodec.ZstdCodec

(

int

level = 3

)

Parameters

level

Compression level 0–22. Default 3 matches zstd's default.

    {
        _level = Math.Clamp(level, 0, 22);
    }

Member Function Documentation

DecodeAsync()

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

Decodes bytes produced by the previous codec step.

Implements ZarrNET.IZarrCodec.

    {
        ct.ThrowIfCancellationRequested();
 
        using var decompressor = new Decompressor();
        var result = decompressor.Unwrap(input);
 
        return Task.FromResult(result.ToArray());
    }

EncodeAsync()

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

Encodes bytes for the next codec step.

Implements ZarrNET.IZarrCodec.

    {
        ct.ThrowIfCancellationRequested();
 
        using var compressor = new Compressor(_level);
        var result = compressor.Wrap(input);
 
        return Task.FromResult(result.ToArray());
    }

Property Documentation

Name

string ZarrNET.ZstdCodec.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/ZstdCodec.cs