Expand description
Pure Rust HDF5 on-disk format codec.
This crate handles encoding and decoding of HDF5 binary structures
(superblock, object headers, messages, chunk indices) without performing
any file I/O. It is used by hdf5-io and hdf5 crates.
Modules§
- btree_
v1 - B-tree v1 decode (for reading legacy HDF5 files).
- checksum
- Jenkins lookup3 hash (hashlittle) – a byte-exact port of HDF5’s H5checksum.c.
- chunk_
index - creation_
order - How an object records the creation order of one of its collections.
- dense_
attr - Dense attribute storage.
- dense_
link - Dense link storage.
- fractal_
heap - Fractal heap reader (read-only).
- fractal_
heap_ write - Fractal heap writer.
- free_
space - Persisted free-space managers: the header block (
FSHD) and the serialized sections that hang off it (FSSE). - global_
heap - Global Heap Collection (GCOL) – stores variable-length data such as variable-length strings.
- local_
heap - Local heap decode (for reading legacy HDF5 files).
- messages
- nbit_
scaleoffset - Pure-Rust ports of the HDF5 N-bit (filter id 5) and Scale-offset (filter id 6) filters.
- object_
header - reference
- Reference elements and the dataspace selections region references carry.
- selection
- Serialized H5S dataspace-selection decoder.
- sohm
- Shared object header messages (SOHM).
- sohm_
write - Laying out a file’s shared object header messages.
- storage_
kind - Storage-kind facts read off the object-header messages that split an
object’s metadata into an inline (compact) shape versus one moved out to
a fractal heap plus a v2 B-tree index (dense) once it grows past the
phase-change threshold. Attribute storage is governed by
AttributeInfoMessage; link storage adds a third, legacy shape (the pre-1.8 symbol table) and is governed byLinkInfoMessage. - superblock
- symbol_
table - Symbol Table Node (SNOD) decode (for reading legacy HDF5 files).
- szip
Structs§
- Format
Context - Format context carrying file-level encoding parameters
Enums§
- Format
Error - Encode/decode error
- Libver
Bound - The low half of libhdf5’s
H5Pset_libver_bounds— the oldest library release a file must stay readable by. - Object
Format - Which generation of the on-disk object format one file’s objects are written in.
Constants§
- UNDEF_
ADDR - UNDEF address constant
Traits§
- Block
Reader - Fetches arbitrary file regions for the structure walkers that cannot hold a file handle themselves (fractal heap, v2 B-tree, dense attribute storage).