Codec Class

Abstract class representing a compressor.

Format

R6::R6Class

Details

Abstract compressor for Zarr

See also

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

Methods

Public methods

• Codec$encode()

• Codec$decode()

• Codec$get_config()

• Codec$clone()

---

Method encode()

Compress data.

Usage

Codec$encode(buf, zarr_arr)

Arguments

buf

(raw())
The un-compressed data.

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Compressed data.

---

Method decode()

Decompress data.

Usage

Codec$decode(buf, zarr_arr)

Arguments

buf

(raw())
The compressed data.

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Un-compressed data.

---

Method get_config()

Get codec configuration as a list.

Usage

Codec$get_config()

Returns

A named list.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Codec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.