Crate hdf5_metno 

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

dataset

Multi-dimensional datasets.

datatype

Datatype objects for defining the layout of a data element.

file

HDF5 file objects.

filters

Filters for data compression and validation during file I/O.

plist

Property list objects.

types

Base types and interfaces for creating compound data types.

Structs

AttrInfo

Information about an attribute of an object.

Attribute

Represents the HDF5 attribute object.

AttributeBuilder

An attribute builder

AttributeBuilderData

An attribute builder with type, shape, and data known

AttributeBuilderEmpty

An attribute builder with the type known

AttributeBuilderEmptyShape

An attribute builder with type and shape known

ByteReader

A reader for a 1-dimensional dataset of bytes.

CommittedDatatype

Represents a committed HDF5 datatype: a datatype stored in a file as an object of its own, which can carry attributes like a group or a dataset.

Container

An object which can be read or written to.

Dataset

Represents the HDF5 dataset object.

DatasetBuilder

A dataset builder

DatasetBuilderData

A dataset builder with type, shape, and data known

DatasetBuilderEmpty

A dataset builder with the type known

DatasetBuilderEmptyShape

A dataset builder with type and shape known

Dataspace

Represents the HDF5 dataspace object.

Datatype

Represents the HDF5 datatype object.

ErrorFrame

An error record for an HDF5 library call.

ErrorStack

A stack of error records from an HDF5 library call.

ExpandedErrorStack

A converted ErrorStack with methods to access ErrorFrame data.

Extent

Current and maximum dimension size for a particular dimension.

File

HDF5 file object.

FileBuilder

File builder allowing to customize file access/creation property lists.

Group

Represents the HDF5 group object.

GroupBuilder

A builder for creating a new Group.

GroupInfo

Information about a group.

Hyperslab

A descriptor of a selection of an N-dimensional array.

IterationCursor

A position in a link or attribute iteration.

LinkInfo

Metadata describing an object link.

Location

Named location (file, group, dataset, named datatype).

LocationInfo

Metadata information describing a Location

LocationToken

A token containing the address or identifier of a Location.

Object

Any HDF5 object that can be referenced through an identifier.

ObjectReference1

ObjectReference21.12.1

PropertyList

Represents the HDF5 property list.

Reader

A type for reading data from a Container.

SimpleExtents

Extents for a simple dataspace, a multidimensional array of elements.

Writer

A type for writing data into a Container.

Enums

Conversion

A level of possible conversion between two types.

DatasetType

The type a dataset is created with.

Error

The error type for HDF5-related functions.

Extents

The dimensionality of a dataspace.

GroupStorageType

How the links of a group are stored.

IndexType

The index the links of a group or the attributes of an object are traversed along.

IterationOrder

The order links or attributes are visited in along an IndexType.

LinkType

The type of an object link.

LocationType

The type of an object in a Location.

MajorErrorCode

The major error code of an HDF5 error frame.

MinorErrorCode

The minor error code of an HDF5 error frame.

OpenMode

File opening mode.

ReferencedObject

The result of dereferencing an object reference.

Selection

A selection used for reading and writing to a Container.

SliceOrIndex

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

A type that can be represented as an HDF5 datatype.

ObjectReference

The trait for all object references. This provides a common interface over the legacy and standard reference types.

Functions

from_id^⚠

Takes ownership of an object via its identifier.

h5check

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 Dimension trait for indexing.

Result

A type for results generated by HDF5-related functions where the Err type is set to hdf5::Error.

Derive Macros

H5Type

Derive macro generating an impl of the trait H5Type.