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
HDF5types. - 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§
- Attribute
- Represents the HDF5 attribute object.
- Attribute
Builder - An attribute builder
- Attribute
Builder Data - An attribute builder with type, shape, and data known
- Attribute
Builder Empty - An attribute builder with the type known
- Attribute
Builder Empty Shape - An attribute builder with type and shape known
- Byte
Reader - Container
- An object which can be read or written to.
- Dataset
- Represents the HDF5 dataset object.
- Dataset
Builder - A dataset builder
- Dataset
Builder Data - A dataset builder with type, shape, and data known
- Dataset
Builder Empty - A dataset builder with the type known
- Dataset
Builder Empty Shape - A dataset builder with type and shape known
- Dataspace
- Represents the HDF5 dataspace object.
- Datatype
- Represents the HDF5 datatype object.
- Error
Frame - Error
Stack - Expanded
Error Stack - Extent
- Current and maximum dimension size for a particular dimension.
- File
- HDF5 file object.
- File
Builder - File builder allowing to customize file access/creation property lists.
- Group
- Represents the HDF5 group object.
- Hyperslab
- A descriptor of a selection of an N-dimensional array.
- Link
Info - Location
- Named location (file, group, dataset, named datatype).
- Location
Info - Metadata information describing a
Location - Location
Token - Object
- Any HDF5 object that can be referenced through an identifier.
- Object
Reference1 - Object
Reference2 - Property
List - Represents the HDF5 property list.
- Reader
- Simple
Extents - Extents for a simple dataspace, a multidimensional array of elements.
- Writer
Enums§
- Conversion
- Error
- The error type for HDF5-related functions.
- Extents
- Link
Type - Location
Type - Open
Mode - File opening mode.
- Referenced
Object - The result of dereferencing an object reference.
- Selection
- A selection used for reading and writing to a
Container. - Slice
OrIndex - A selector of a one-dimensional array
Constants§
- HDF5_
VERSION - HDF5 library version used at link time. See
hdf5_sys::HDF5_VERSION
Traits§
- Dimension
- A trait for the shape and index types.
- H5Type
- Object
Reference - The trait for all object references. This provides a common interface over the legacy and standard reference types.
Functions§
- from_id⚠
- is_
library_ threadsafe - Returns true if the HDF5 library is threadsafe.
- library_
version - Returns the runtime version of the HDF5 library.
- silence_
errors - Silence errors emitted by
hdf5
Type Aliases§
- Ix
- A scalar integer type used by
Dimensiontrait for indexing. - Result
- A type for results generated by HDF5-related functions where the
Errtype is set tohdf5::Error.