ZstdCodec Class

Class representing a ZSTD compressor

Details

ZSTD compressor for Zarr

Super class

pizzarr::Codec -> ZstdCodec

Public fields

level

The compression level.

Methods

Public methods

• ZstdCodec$new()

• ZstdCodec$encode()

• ZstdCodec$decode()

• ZstdCodec$get_config()

• ZstdCodec$clone()

---

Method new()

Create a new ZSTD compressor.

Usage

ZstdCodec$new(level = 1)

Arguments

level

The compression level, between 1 and 22.

Returns

A new ZstdCodec object.

---

Method encode()

Compress data.

Usage

ZstdCodec$encode(buf, zarr_arr)

Arguments

buf

The un-compressed data.

zarr_arr

The ZarrArray instance.

Returns

Compressed data.

---

Method decode()

Decompress data.

Usage

ZstdCodec$decode(buf, zarr_arr)

Arguments

buf

The compressed data.

zarr_arr

The ZarrArray instance.

Returns

Un-compressed data.

---

Method get_config()

Get Configuration

Usage

ZstdCodec$get_config()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ZstdCodec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.