Crate zarrs_codec 

The codec API for the zarrs crate.

Licence

zarrs_codec is licensed under either of

• the Apache License, Version 2.0 LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0 or
• the MIT license LICENSE-MIT or http://opensource.org/licenses/MIT, at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Structs

ArrayBytesFixedDisjointView

A disjoint view of the bytes in an array with a fixed-length data type.

ArrayBytesOffsets

Array element byte offsets.

ArrayBytesOptional

Optional array bytes composed of data and a validity mask.

ArrayBytesRawOffsetsOutOfBoundsError

An error raised if variable length array bytes offsets are out of bounds.

ArrayBytesVariableLength

Variable length array bytes composed of bytes and element bytes offsets.

ByteIntervalPartialDecoder

A partial decoder for a byte interval of a BytesPartialDecoderTraits partial decoder.

CodecMetadataOptions

Options for codec metadata.

CodecOptions

Codec options for encoding/decoding.

CodecPartialDefault

Generic partial codec for all codec operations with default behavior.

CodecPluginV2

A Zarr V2 codec plugin.

CodecPluginV3

A Zarr V3 codec plugin.

ExpectedFixedLengthBytesError

Expected fixed length array bytes but found variable or optional.

ExpectedOptionalBytesError

Expected optional array bytes but found fixed or variable.

ExpectedVariableLengthBytesError

Expected variable length array bytes but found fixed or optional.

InvalidArrayShapeError

An error indicating the shape is not compatible with the expected number of elements.

InvalidBytesLengthError

An error indicating the length of bytes does not match the expected length.

InvalidNumberOfElementsError

An error indicating the length of elements does not match the expected length.

PartialDecoderCapability

Describes the partial decoding capabilities of a codec.

PartialEncoderCapability

Describes the partial encoding capabilities of a codec.

RecommendedConcurrency

The recommended concurrency of a codec includes the most efficient and maximum recommended concurrency.

StoragePartialDecoder

A ReadableStorage store value partial decoder.

StoragePartialEncoder

A store value partial encoder generic over storage type.

SubsetOutOfBoundsError

An array subset is out of bounds.

Enums

ArrayBytes

Fixed or variable length array bytes.

ArrayBytesDecodeIntoTarget

A target for decoding array bytes into a preallocated output view.

ArrayBytesError

Errors related to ArrayBytes<'_> and ArrayBytes.

ArrayBytesFixedDisjointViewCreateError

Errors that can occur when creating a ArrayBytesFixedDisjointView.

ArrayBytesRawOffsetsCreateError

An error creating ArrayBytesOffsets.

BytesRepresentation

The decoded representation of bytes.

Codec

A generic array to array, array to bytes, or bytes to bytes codec.

CodecError

A codec error.

CodecMetadata

Codec metadata for different Zarr versions.

Statics

CODEC_RUNTIME_REGISTRY_V2

Global runtime registry for V2 codec plugins.

CODEC_RUNTIME_REGISTRY_V3

Global runtime registry for V3 codec plugins.

Traits

ArrayCodecTraits

Traits for both array to array and array to bytes codecs.

ArrayPartialDecoderTraits

Partial array decoder traits.

ArrayPartialEncoderTraits

Partial array encoder traits.

ArrayToArrayCodecTraits

Traits for array to array codecs.

ArrayToBytesCodecTraits

Traits for array to bytes codecs.

BytesPartialDecoderTraits

Partial bytes decoder traits.

BytesPartialEncoderTraits

Partial bytes encoder traits.

BytesToBytesCodecTraits

Traits for bytes to bytes codecs.

CodecTraits

Codec traits.

CodecTraitsV2

Trait for creating a codec from Zarr V2 metadata.

CodecTraitsV3

Trait for creating a codec from Zarr V3 metadata.

Functions

copy_fill_value_into

Decode the fill value into a subset of a preallocated output.

decode_into_array_bytes_target

Helper function to decode ArrayBytes into a target, handling mask and data separately.

register_codec_v2

Register a V2 codec plugin at runtime.

register_codec_v3

Register a V3 codec plugin at runtime.

unregister_codec_v2

Unregister a runtime V2 codec plugin.

unregister_codec_v3

Unregister a runtime V3 codec plugin.

update_array_bytes

Update array bytes.

Type Aliases

ArrayBytesRaw

Raw array element bytes.

CodecRuntimePluginV2

A runtime V2 codec plugin for dynamic registration.

CodecRuntimePluginV3

A runtime V3 codec plugin for dynamic registration.

CodecRuntimeRegistryHandleV2

A handle to a registered V2 codec plugin.

CodecRuntimeRegistryHandleV3

A handle to a registered V3 codec plugin.