Bz2Codec Class

Class representing a bz2 compressor

Format

R6::R6Class inheriting from Codec.

Details

Bz2 compressor for Zarr

See also

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

Super class

pizzarr::Codec -> Bz2Codec

Public fields

level

The compression level.

Methods

Public methods

• Bz2Codec$new()

• Bz2Codec$encode()

• Bz2Codec$decode()

• Bz2Codec$get_config()

• Bz2Codec$clone()

---

Method new()

Create a new Bz2 compressor.

Usage

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

Arguments

level

The compression level, between 1 and 22.

...

Not used.

Returns

A new Bz2Codec object.

---

Method encode()

Compress data.

Usage

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

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

Bz2Codec$get_config()

Returns

A named list.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Bz2Codec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.