VLenUtf8Codec Class

Class representing a VLenUtf8 compressor

Format

R6::R6Class inheriting from Codec.

Details

Variable-length UTF-8 codec for Zarr

See also

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

Super class

pizzarr::Codec -> VLenUtf8Codec

Methods

Public methods

• VLenUtf8Codec$encode()

• VLenUtf8Codec$decode()

• VLenUtf8Codec$get_config()

• VLenUtf8Codec$clone()

---

Method encode()

Compress data.

Usage

VLenUtf8Codec$encode(buf, zarr_arr)

Arguments

buf

(character())
The un-compressed data (character vector).

zarr_arr

(ZarrArray)
The ZarrArray instance.

Returns

Compressed data.

---

Method decode()

Decompress data.

Usage

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

VLenUtf8Codec$get_config()

Returns

A named list.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

VLenUtf8Codec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.