ZarrNET.BytesCodec Class Reference

The "bytes" array-to-bytes codec (Zarr v3 spec section 3.3.2). Handles endianness conversion when translating between the in-memory array representation and a flat byte sequence. This is always the first codec in a Zarr v3 pipeline. More...

Inheritance diagram for ZarrNET.BytesCodec:

Public Member Functions
	BytesCodec (ByteOrder byteOrder=ByteOrder.LittleEndian)
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

The "bytes" array-to-bytes codec (Zarr v3 spec section 3.3.2). Handles endianness conversion when translating between the in-memory array representation and a flat byte sequence. This is always the first codec in a Zarr v3 pipeline.

Constructor & Destructor Documentation

BytesCodec()

ZarrNET.BytesCodec.BytesCodec

(

ByteOrder

byteOrder = ByteOrder::LittleEndian

)

    {
        _byteOrder = byteOrder;
    }

Member Function Documentation

DecodeAsync()

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

Decodes bytes produced by the previous codec step.

Implements ZarrNET.IZarrCodec.

    {
        ct.ThrowIfCancellationRequested();
 
        var result = NeedsSwap()
            ? SwapByteOrder(input)
            : input;
 
        return Task.FromResult(result);
    }

EncodeAsync()

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

Encodes bytes for the next codec step.

Implements ZarrNET.IZarrCodec.

    {
        ct.ThrowIfCancellationRequested();
 
        // Swap is its own inverse
        var result = NeedsSwap()
            ? SwapByteOrder(input)
            : input;
 
        return Task.FromResult(result);
    }

Property Documentation

Name

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