Skip to main content

Crate hdf5_rust

Crate hdf5_rust 

Source
Expand description

Pure-Rust HDF5 reader and writer. No libhdf5, no C FFI, no crate dependencies.

IEEE values are integer bit patterns (u64 / u32). Opaque datasets are raw records. Hardware IEEE arithmetic is not used.

Atomic n-bit decompression, little-endian integer scale-offset, Fletcher32, and Huff::decode are derived from HDF5 and from puff.c. The copyright and permission notices for those portions are in the crate NOTICE.

Structs§

CompoundField
One member of a compound datatype.
Hdf5File
An HDF5 file held as a logical graph and (re)serialized to bytes on demand.

Enums§

CompoundMemberKind
Member kind reported for compound field introspection.
HDF5DType
Dataset datatype as reported by Hdf5File::dataset_dtype.
HDF5Error
Recoverable HDF5 failure. Public variants listed in the build spec are stable; additional variants describe truncated or malformed files.

Constants§

HDF5_ATTR_VERSION
Attribute message version written by this crate.
HDF5_BTREE_CHUNK
B-tree node type: raw data chunks.
HDF5_BTREE_GROUP
B-tree node type: group (symbol table).
HDF5_CLASS_COMPOUND
Datatype class: compound / structured.
HDF5_CLASS_FLOAT
Datatype class: floating-point.
HDF5_CLASS_INTEGER
Datatype class: fixed-point integer.
HDF5_CLASS_OPAQUE
Datatype class: opaque.
HDF5_CLASS_STRING
Datatype class: string.
HDF5_CLASS_VLEN
Datatype class: variable-length.
HDF5_CREATED_ATTR
Second dataset attribute written on every dataset this crate creates.
HDF5_DATASPACE_VERSION
Dataspace message version written by this crate.
HDF5_DTYPE_VERSION
Datatype message version for IEEE and opaque.
HDF5_FILL_VERSION
Fill-value message version.
HDF5_GCOL_SIGNATURE
Global heap collection signature.
HDF5_HEAP_SIGNATURE
Local heap signature.
HDF5_LAYOUT_CHUNKED
Layout class: chunked.
HDF5_LAYOUT_COMPACT
Layout class: compact.
HDF5_LAYOUT_CONTIGUOUS
Layout class: contiguous.
HDF5_LAYOUT_VERSION
Layout message version written by this crate.
HDF5_LENGTH_SIZE
Size of lengths this crate writes (bytes).
HDF5_LINK_VERSION
Link message version.
HDF5_MAX_DIMS
Maximum dataspace rank (HDF5 format H5S_MAX_RANK). Rank 2 is not a cap.
HDF5_MAX_NAME_LEN
Maximum link / attribute / path component length in bytes.
HDF5_MAX_WALK_DEPTH
Maximum object-header walk depth (continuation + nested groups).
HDF5_MSG_ATTRIBUTE
Header message type: attribute.
HDF5_MSG_CONTINUATION
Header message type: continuation.
HDF5_MSG_DATASPACE
Header message type: dataspace.
HDF5_MSG_DATATYPE
Header message type: datatype.
HDF5_MSG_FILL
Header message type: fill value.
HDF5_MSG_FILTER
Header message type: filter pipeline.
HDF5_MSG_FLAG_CONSTANT
Object-header v1 message flags: data is constant.
HDF5_MSG_GROUP_INFO
Header message type: group info.
HDF5_MSG_LAYOUT
Header message type: layout.
HDF5_MSG_LINK
Header message type: link.
HDF5_MSG_LINK_INFO
Header message type: link info.
HDF5_MSG_NIL
Header message type: nil.
HDF5_MSG_SYMBOL_TABLE
Header message type: symbol table (old-style group).
HDF5_OCHK_SIGNATURE
Object-header continuation chunk signature.
HDF5_OFFSET_SIZE
Size of offsets this crate writes (bytes).
HDF5_OHDR_FLAGS_CHUNK4
Object-header flags: 4-byte chunk-0 size, no timestamps.
HDF5_OHDR_SIGNATURE
Object-header signature for version 2 headers.
HDF5_OHDR_VERSION
Object-header v2 version byte.
HDF5_OPAQUE_TAG
Opaque ASCII tag written on opaque datatypes (NUL-padded to 8).
HDF5_SIGNATURE
HDF5 format signature (\211HDF\r\n\032\n).
HDF5_SNOD_SIGNATURE
Symbol-table node signature.
HDF5_SPACE_SCALAR
Dataspace type: scalar.
HDF5_SPACE_SIMPLE
Dataspace type: simple.
HDF5_SUPERBLOCK_SEARCH_START
Superblock search: first candidate after offset 0.
HDF5_SUPERBLOCK_V2
Superblock version this crate writes.
HDF5_SUPERBLOCK_V2_SIZE
Superblock v2 on-disk size with 8-byte offsets (including checksum).
HDF5_TREE_SIGNATURE
Version-1 B-tree node signature.
HDF5_UNDEF_ADDR_8
Undefined address for 8-byte offsets.
HDF5_UNLIMITED
Maximum first-dimension extent (HDF5 unlimited).
HDF5_WRITER_VERSION
Value stored in HDF5_WRITER_VERSION_ATTR (this crate’s version).
HDF5_WRITER_VERSION_ATTR
Dataset attribute written on every dataset this crate creates.

Functions§

dataset_dtype
Datatype of dataset path.
dataset_shape
Shape of dataset path.
list_datasets
Dataset paths in file.
list_groups
Group paths in file.

Type Aliases§

Result
Result alias for this crate’s HDF5Error.