Crate hdf5[−][src]
Expand description
HDF5 for Rust.
This crate provides thread-safe Rust bindings and high-level wrappers for the HDF5
library API. Some of the features include:
- Thread-safety with non-threadsafe libhdf5 builds guaranteed via reentrant mutexes.
- Native representation of most HDF5 types, including variable-length strings and arrays.
- Derive-macro for automatic mapping of user structs and enums to
HDF5
types. - Multi-dimensional array reading/writing interface via
ndarray
.
Direct low-level bindings are also available and provided in the hdf5-sys
crate.
Requires HDF5
library of version 1.8.4 or later. Newer versions will enable additional
features of the library. Such items are marked in the documentation with a version number
indicating the required version of HDF5
. The have-direct
and have-parallel
features
also indicates HDF5
functionality.
Modules
Structs
Represents the HDF5 attribute object.
An attribute builder
An attribute builder with type, shape, and data known
An attribute builder with the type known
An attribute builder with type and shape known
An object which can be read or written to.
Represents the HDF5 dataset object.
A dataset builder
A dataset builder with type, shape, and data known
A dataset builder with the type known
A dataset builder with type and shape known
Represents the HDF5 dataspace object.
Represents the HDF5 datatype object.
Current and maximum dimension size for a particular dimension.
HDF5 file object.
File builder allowing to customize file access/creation property lists.
Represents the HDF5 group object.
A descriptor of a selection of an N-dimensional array.
Named location (file, group, dataset, named datatype).
Metadata information describing a Location
Any HDF5 object that can be referenced through an identifier.
Represents the HDF5 property list.
Extents for a simple dataspace, a multidimensional array of elements.
Enums
The error type for HDF5-related functions.
A selector of a one-dimensional array
Traits
Functions
Returns true if the HDF5 library is threadsafe.
Returns the runtime version of the HDF5 library.
Silence errors emitted by hdf5
Type Definitions
A scalar integer type used by Dimension
trait for indexing.
A type for results generated by HDF5-related functions where the Err
type is
set to hdf5::Error
.