Module zarrs::array

Zarr arrays.

An array is a node in a Zarr hierarchy used to hold multidimensional array data and associated metadata. See https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html#array.

Use ArrayBuilder to setup a new array, or use Array::new for an existing array. The documentation for Array details how to interact with arrays.

Re-exports

• pub use self::chunk_grid::ChunkGrid;
• pub use self::chunk_key_encoding::ChunkKeyEncoding;
• pub use self::codec::ArrayCodecTraits;
• pub use self::codec::CodecChain;
• pub use self::concurrency::RecommendedConcurrency;
• pub use self::data_type::DataType;

Modules

• chunk_grid
  Zarr chunk grids. Includes a regular grid implementation.
• chunk_key_encoding
  Zarr chunk key encodings. Includes a default and v2 implementation.
• codec
  Zarr codecs.
• concurrency
  Concurrency utilities for arrays and codecs.
• data_type
  Zarr data types.

Structs

• Array
  A Zarr array.
• ArrayBuilder
  An Array builder.
• ArrayMetadataOptions
  Options for writing array metadata.
• ArrayMetadataV3
  Zarr array metadata (storage specification v3).
• ArrayShardedReadableExtCachesharding
  A cache used for methods in the ArrayShardedReadableExt trait.
• ArrayView
  A view of a subset of an array.
• ChunkShape
  The shape of a chunk. All dimensions must be non-zero.
• DimensionName
  A dimension name.
• FillValue
  The fill value of the Zarr array.
• NonZeroError
  A non zero error.
• UnsafeCellSlice
  An unsafe cell slice.

Enums

• ArrayCreateError
  An array creation error.
• ArrayError
  Array errors.
• ArrayMetadata
  Zarr array metadata.
• ArrayViewCreateError
  An array view create error.
• BytesRepresentation
  The decoded representation of bytes.
• FillValueMetadata
  Fill value metadata.

Constants

• ZARR_NAN_BF16
  The Zarr “NaN” fill value for a 16-bit brain floating point number.
• ZARR_NAN_F16
  The Zarr “NaN” fill value for a 16-bit IEEE 754 floating point number.
• ZARR_NAN_F32
  The Zarr “NaN” fill value for a 32-bit IEEE 754 floating point number.
• ZARR_NAN_F64
  The Zarr “NaN” fill value for a 64-bit IEEE 754 floating point number.

Traits

• ArrayShardedExtsharding
  An Array extension trait to simplify working with arrays using the sharding_indexed codec.
• ArrayShardedReadableExtsharding
  An Array extension trait to efficiently read data (e.g. inner chunks) from arrays using the sharding_indexed codec.

Functions

• bytes_to_ndarrayndarray
  Convert a vector of bytes to an ndarray::ArrayD.
• chunk_shape_to_array_shape
  Convert a ChunkShape to an ArrayShape.
• elements_to_ndarrayndarray
  Convert a vector of elements to an ndarray::ArrayD.
• ravel_indices
  Ravel ND indices to a linearised index.
• transmute_from_bytes_vec
  Transmute from Vec<u8> to Vec<T>.
• transmute_to_bytes_vec
  Transmute from Vec<T> to Vec<u8>.
• unravel_index
  Unravel a linearised index to ND indices.

Type Aliases

• ArrayIndices
  An ND index to an element in an array.
• ArrayRepresentation
  The array representation of an array, which can have zero dimensions.
• ArrayShape
  The shape of an array.
• ChunkRepresentation
  The array representation of a chunk, which must have nonzero dimensions.
• MaybeBytes
  An alias for bytes which may or may not be available.