ZarrNET.CodecPipeline Class Reference

Applies an ordered list of codecs as a pipeline. More...

Public Member Functions
	CodecPipeline (IReadOnlyList< IZarrCodec > codecs, int byteOrderElementSize)
Task< byte[]>	DecodeAsync (byte[] input, CancellationToken ct=default)
Task< byte[]>	EncodeAsync (byte[] input, CancellationToken ct=default)

Properties
bool	CanStoreDecodedBytesWithoutTransform [get]
	True when encoded storage bytes are identical to decoded in-memory array bytes. This allows whole-chunk IO to bypass byte-array materialization without skipping any Zarr-required transform.

Detailed Description

Applies an ordered list of codecs as a pipeline.

Zarr v3 codec pipeline: Decode: last codec → ... → first codec (compressed bytes → array bytes) Encode: first codec → ... → last codec (array bytes → compressed bytes)

The pipeline also resolves byte-order swapping for the BytesCodec based on the data type byte-order element size from ZarrArrayMetadata. For complex dtypes this is the real/imag component size, not the full complex size.

When all codecs in the pipeline are synchronous (returning completed Tasks), the decode/encode path avoids async state machine overhead entirely. This is the common case for Blosc, Zstd, and BytesCodec pipelines.

Constructor & Destructor Documentation

CodecPipeline()

ZarrNET.CodecPipeline.CodecPipeline	(	IReadOnlyList< IZarrCodec >	codecs,
		int	byteOrderElementSize )

    {
        _codecs               = codecs;
        _byteOrderElementSize = byteOrderElementSize;
 
        // Detect whether every codec in the pipeline is synchronous.
        // Synchronous codecs return Task.FromResult — we identify them by
        // interface marker or by known type. GzipCodec is the only async
        // codec in the codebase (uses Stream.CopyToAsync).
        _allCodecsSync = codecs.All(c => c is not GzipCodec);
    }

Member Function Documentation

DecodeAsync()

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

    {
        // Fast path: when all codecs are synchronous, avoid async state machine
        if (_allCodecsSync)
            return Task.FromResult(DecodeSynchronous(input, ct));
 
        return DecodeAsyncCore(input, ct);
    }

EncodeAsync()

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

    {
        if (_allCodecsSync)
            return Task.FromResult(EncodeSynchronous(input, ct));
 
        return EncodeAsyncCore(input, ct);
    }

---

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

• ZarrNET/CodecPipeline.cs