ZlibCodec Class

Class representing a zlib compressor

Format

R6::R6Class inheriting from Codec.

Details

Zlib compressor for Zarr

See also

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

Super class

Codec -> ZlibCodec

Public fields

level

The compression level.

Methods

Public methods

• ZlibCodec$new()

• ZlibCodec$encode()

• ZlibCodec$decode()

• ZlibCodec$get_config()

• ZlibCodec$clone()

---

ZlibCodec$new()

Create a new Zlib compressor.

Usage

ZlibCodec$new(level = 6, ...)

Arguments

level

The compression level, between 1 and 22.

...

Not used.

Returns

A new ZlibCodec object.

---

ZlibCodec$encode()

Compress data.

Usage

ZlibCodec$encode(buf, zarr_arr)

Arguments

buf

(raw())
The un-compressed data.

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Compressed data.

---

ZlibCodec$decode()

Decompress data.

Usage

ZlibCodec$decode(buf, zarr_arr)

Arguments

buf

(raw())
The compressed data.

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Un-compressed data.

---

ZlibCodec$get_config()

Get codec configuration as a list.

Usage

ZlibCodec$get_config()

Returns

A named list.

---

ZlibCodec$clone()

The objects of this class are cloneable with this method.

Usage

ZlibCodec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.