ZstdCodec Class

Class representing a ZSTD compressor

Format

R6::R6Class inheriting from Codec.

Details

ZSTD compressor for Zarr

See also

Other Codec classes: BloscCodec, Bz2Codec, Codec, GzipCodec, Lz4Codec, LzmaCodec, VLenUtf8Codec, ZlibCodec

Super class

Codec -> ZstdCodec

Public fields

level

The compression level.

Methods

Public methods

• ZstdCodec$new()

• ZstdCodec$encode()

• ZstdCodec$decode()

• ZstdCodec$get_config()

• ZstdCodec$clone()

---

ZstdCodec$new()

Create a new ZSTD compressor.

Usage

ZstdCodec$new(level = 1, ...)

Arguments

level

The compression level, between 1 and 22.

...

Not used.

Returns

A new ZstdCodec object.

---

ZstdCodec$encode()

Compress data.

Usage

ZstdCodec$encode(buf, zarr_arr)

Arguments

buf

(raw())
The un-compressed data.

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Compressed data.

---

ZstdCodec$decode()

Decompress data.

Usage

ZstdCodec$decode(buf, zarr_arr)

Arguments

buf

(raw())
The compressed data.

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Un-compressed data.

---

ZstdCodec$get_config()

Get codec configuration as a list.

Usage

ZstdCodec$get_config()

Returns

A named list.

---

ZstdCodec$clone()

The objects of this class are cloneable with this method.

Usage

ZstdCodec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.