GzipCodec Class

Class representing a gzip compressor.

Gzip encoding uses temporary files because R's memCompress() produces zlib framing rather than gzip framing. This makes GzipCodec slower than ZstdCodec for writes. Prefer ZstdCodec when performance matters.

Format

R6::R6Class inheriting from Codec.

Details

Gzip compressor for Zarr

See also

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

Super class

pizzarr::Codec -> GzipCodec

Public fields

level

The compression level.

Methods

Public methods

• GzipCodec$new()

• GzipCodec$encode()

• GzipCodec$decode()

• GzipCodec$get_config()

• GzipCodec$clone()

---

Method new()

Create a new Gzip compressor.

Usage

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

Arguments

level

The compression level, between 1 and 22.

...

Not used.

Returns

A new GzipCodec object.

---

Method encode()

Compress data.

Usage

GzipCodec$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

GzipCodec$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

GzipCodec$get_config()

Returns

A named list.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GzipCodec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.