Crate icechunk_format 

Icechunk data types and serialization.

Defines ID types (SnapshotId, ManifestId, ChunkId, NodeId), Path for normalized Zarr paths, and ByteRange/ChunkIndices for chunk addressing. Submodules define snapshots, manifests, and transaction logs.

Modules

attributes

User attributes stored on arrays and groups. Placeholder for user attributes on arrays and groups.

flatbuffers

Generated Flatbuffer types for binary serialization.

format_constants

Binary format constants (file types, spec versions, compression).

manifest

Chunk reference tables. Chunk reference tables mapping coordinates to storage locations.

repo_info

Repository metadata (version, properties). Version info, branches, and tags for a repository.

serializers

Flatbuffer serialization. Flatbuffer serialization for Icechunk metadata.

snapshot

Repository state at a point in time. Repository state at a point in time (arrays, groups, and manifest references).

transaction_log

Change records for commits. Change records for commits, enabling conflict detection during rebase.

Macros

roundtrip_serialization_tests

Structs

AttributesTag

Type tag for AttributesId.

ChunkIndices

An ND index to an element in a chunk grid.

ChunkTag

Type tag for ChunkId.

ManifestTag

Type tag for ManifestId.

Move

NodeTag

Type tag for NodeId.

ObjectId

The id of a file in object store

Path

A normalized Zarr path: absolute (starts with /) and no trailing slash.

SnapshotTag

Type tag for SnapshotId.

Enums

ByteRange

A byte range within a chunk or object.

IcechunkFormatErrorKind

Format-level error types.

NodeType

PathError

Errors when constructing a Path.

Constants

CHUNKS_FILE_PATH

CONFIG_FILE_PATH

MANIFESTS_FILE_PATH

OVERWRITTEN_FILES_PATH

REPO_INFO_FILE_PATH

SNAPSHOTS_FILE_PATH

TRANSACTION_LOGS_FILE_PATH

V1_REFS_FILE_PATH

Traits

FileTypeTag

Marker trait for object ID type tags (sealed).

Functions

lookup_index_by_key

Type Aliases

AttributesId

Unique identifier for an attributes blob.

ChunkId

Unique identifier for a chunk.

ChunkLength

Size of a chunk in bytes.

ChunkOffset

Byte offset within a chunk.

IcechunkFormatError

IcechunkResult

ManifestId

Unique identifier for a manifest file.

NodeId

The internal id of an array or group, unique only to a single store version

SnapshotId

Unique identifier for a snapshot.

TableOffset

Offset within a manifest table.