Module zarrs::array::codec

Zarr codecs.

Array chunks can be encoded using a sequence of codecs, each of which specifies a bidirectional transform (an encode transform and a decode transform). A codec can map array to an array, an array to bytes, or bytes to bytes. A codec may support partial decoding to extract a byte range or array subset without needing to decode the entire input.

A CodecChain represents a codec sequence consisting of any number of array to array and bytes to bytes codecs, and one array to bytes codec. A codec chain is itself an array to bytes codec. A ArrayPartialDecoderCache or BytesPartialDecoderCache may be inserted into a codec chain to optimise partial decoding where appropriate.

See https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html#id18.

Re-exports

• pub use options::CodecOptions;
• pub use options::CodecOptionsBuilder;
• pub use array_to_array::bitround::BitroundCodec;
  bitround
• pub use array_to_array::bitround::BitroundCodecConfiguration;
  bitround
• pub use array_to_array::bitround::BitroundCodecConfigurationV1;
  bitround
• pub use array_to_array::transpose::TransposeCodec;
  transpose
• pub use array_to_array::transpose::TransposeCodecConfiguration;
  transpose
• pub use array_to_array::transpose::TransposeCodecConfigurationV1;
  transpose
• pub use array_to_bytes::bytes::BytesCodec;
• pub use array_to_bytes::bytes::BytesCodecConfiguration;
• pub use array_to_bytes::bytes::BytesCodecConfigurationV1;
• pub use array_to_bytes::codec_chain::CodecChain;
• pub use array_to_bytes::pcodec::PcodecCodec;
  pcodec
• pub use array_to_bytes::pcodec::PcodecCodecConfiguration;
  pcodec
• pub use array_to_bytes::pcodec::PcodecCodecConfigurationV1;
  pcodec
• pub use array_to_bytes::sharding::ShardingCodec;
  sharding
• pub use array_to_bytes::sharding::ShardingCodecConfiguration;
  sharding
• pub use array_to_bytes::sharding::ShardingCodecConfigurationV1;
  sharding
• pub use array_to_bytes::zfp::ZfpCodec;
  zfp
• pub use array_to_bytes::zfp::ZfpCodecConfiguration;
  zfp
• pub use array_to_bytes::zfp::ZfpCodecConfigurationV1;
  zfp
• pub use bytes_to_bytes::blosc::BloscCodec;
  blosc
• pub use bytes_to_bytes::blosc::BloscCodecConfiguration;
  blosc
• pub use bytes_to_bytes::blosc::BloscCodecConfigurationV1;
  blosc
• pub use bytes_to_bytes::bz2::Bz2Codec;
  bz2
• pub use bytes_to_bytes::bz2::Bz2CodecConfiguration;
  bz2
• pub use bytes_to_bytes::bz2::Bz2CodecConfigurationV1;
  bz2
• pub use bytes_to_bytes::crc32c::Crc32cCodec;
  crc32c
• pub use bytes_to_bytes::crc32c::Crc32cCodecConfiguration;
  crc32c
• pub use bytes_to_bytes::crc32c::Crc32cCodecConfigurationV1;
  crc32c
• pub use bytes_to_bytes::gzip::GzipCodec;
  gzip
• pub use bytes_to_bytes::gzip::GzipCodecConfiguration;
  gzip
• pub use bytes_to_bytes::gzip::GzipCodecConfigurationV1;
  gzip
• pub use bytes_to_bytes::zstd::ZstdCodec;
  zstd
• pub use bytes_to_bytes::zstd::ZstdCodecConfiguration;
  zstd
• pub use bytes_to_bytes::zstd::ZstdCodecConfigurationV1;
  zstd

Modules

• array_to_array
  Array to array codecs.
• array_to_bytes
  Array to bytes codecs.
• bytes_to_bytes
  Bytes to bytes codecs.
• options
  Codec options for encoding and decoding.

Structs

• ArrayPartialDecoderCache
  A cache for an ArrayPartialDecoderTraits partial decoder.
• AsyncByteIntervalPartialDecoderasync
  A partial decoder for a byte interval of a AsyncBytesPartialDecoderTraits partial decoder.
• AsyncStoragePartialDecoderasync
  An AsyncReadableStorage store value partial decoder.
• ByteIntervalPartialDecoder
  A partial decoder for a byte interval of a BytesPartialDecoderTraits partial decoder.
• BytesPartialDecoderCache
  A cache for a BytesPartialDecoderTraits partial decoder.
• StoragePartialDecoder
  A ReadableStorage store value partial decoder.

Enums

• Codec
  A generic array to array, array to bytes, or bytes to bytes codec.
• CodecError
  A codec error.

Traits

• ArrayCodecTraits
  Traits for both array to array and array to bytes codecs.
• ArrayPartialDecoderTraits
  Partial array decoder traits.
• ArrayToArrayCodecTraits
  Traits for array to array codecs.
• ArrayToBytesCodecTraits
  Traits for array to bytes codecs.
• AsyncArrayPartialDecoderTraitsasync
  Asynchronous partial array decoder traits.
• AsyncBytesPartialDecoderTraitsasync
  Asynchronous partial bytes decoder traits.
• BytesPartialDecoderTraits
  Partial bytes decoder traits.
• BytesToBytesCodecTraits
  Traits for bytes to bytes codecs.
• CodecTraits
  Codec traits.

Functions

• extract_byte_ranges_read
  Extract byte ranges from bytes implementing Read.
• extract_byte_ranges_read_seek
  Extract byte ranges from bytes implementing Read and Seek.

Type Aliases

• CodecPlugin
  A codec plugin.