ddn.lib.hdf5.h5i

HDF5 Identifier Binding

This module provides D bindings for HDF5 identifier operations (H5I API).

License

BSD-3-Clause
alias H5I_free_t H5I_future_discard_func_t H5I_future_realize_func_t H5I_iterate_func_t H5I_search_func_t
enum H5I_type_t
fn H5Iclear_type H5Idec_ref H5Idec_type_ref H5Idestroy_type H5Iget_file_id H5Iget_name H5Iget_ref H5Iget_type H5Iget_type_ref H5Iinc_ref H5Iinc_type_ref H5Iis_valid H5Iiterate H5Inmembers H5Iobject_verify H5Iregister H5Iregister_future H5Iregister_type H5Iremove_verify H5Isearch H5Itype_exists

Types 6

enumH5I_type_t : int

Identifier type

UNINIT = - 2
BADID = - 1
FILE = 1
GROUP = 2
DATATYPE = 3
DATASPACE = 4
DATASET = 5
MAP = 6
ATTR = 7
VFL = 8
VOL = 9
GENPROP_CLS = 10
GENPROP_LST = 11
ERROR_CLASS = 12
ERROR_MSG = 13
ERROR_STACK = 14
SPACE_SEL_ITER = 15
EVENTSET = 16
NTYPES = 17
aliasH5I_free_t = herr_t function(void * obj, void * * request)

Callback function type for freeing objects when an ID type is cleared.

This function is called when clearing an ID type (via H5Iclear_type or H5Idestroy_type) to free the associated objects.

Parameters

objPointer to the object to be freed
requestPointer to a request pointer (for async operations, can be null)

Returns

Non-negative on success, negative on failure.
aliasH5I_search_func_t = int function(void * obj, hid_t id, void * key)

Callback function type for searching through IDs.

This function is called for each ID when searching through an ID type.

Parameters

objPointer to the object associated with the ID
idThe identifier being examined
keyUser-supplied key for comparison

Returns

Positive if the object matches the search criteria (stops search),

zero to continue searching, negative on error.

aliasH5I_iterate_func_t = herr_t function(hid_t id, void * udata) @nogc nothrow

Callback function type for iterating over IDs.

This function is called for each ID when iterating through an ID type using H5Iiterate().

Parameters

idThe identifier being visited
udataUser-supplied data pointer

Returns

H5_ITER_CONT (0) to continue iteration, H5_ITER_STOP (1) to stop,

or negative value on error.

aliasH5I_future_realize_func_t = herr_t function(void * future_object, hid_t * actual_object_id) @nogc nothrow

Callback function type for realizing a future object.

This callback is invoked when a "future" object needs to be converted to an actual object. Used with H5Iregister_future().

Parameters

future_objectPointer to the future object to realize
actual_object_idPointer to receive the actual object's identifier

Returns

Non-negative on success, negative on failure.
aliasH5I_future_discard_func_t = herr_t function(void * future_object) @nogc nothrow

Callback function type for discarding a future object.

This callback is invoked when a "future" object is being discarded without being realized. Used with H5Iregister_future().

Parameters

future_objectPointer to the future object to discard

Returns

Non-negative on success, negative on failure.

Functions 21

fnH5I_type_t H5Iget_type(hid_t id)Gets the type of an identifier
fnhid_t H5Iget_file_id(hid_t id)Gets the file identifier for an object
fnssize_t H5Iget_name(hid_t id, char * name, size_t size)Gets the name of an object
fnint H5Iinc_ref(hid_t id)Increments reference count
fnint H5Idec_ref(hid_t id)Decrements reference count
fnint H5Iget_ref(hid_t id)Gets reference count
fnhtri_t H5Iis_valid(hid_t id)Checks if identifier is valid
fnhtri_t H5Itype_exists(H5I_type_t type)Checks if identifier type exists
fnherr_t H5Inmembers(H5I_type_t type, hsize_t * num_members)Gets number of identifiers of a type
fnherr_t H5Iclear_type(H5I_type_t type, hbool_t force)Clears identifiers of a type
fnhid_t H5Iregister(H5I_type_t type, const void * object)Registers an object and returns a new identifier for it.
fnvoid * H5Iobject_verify(hid_t id, H5I_type_t type)Returns the object referenced by an identifier, verifying its type.
fnvoid * H5Iremove_verify(hid_t id, H5I_type_t type)Removes an identifier from its type and returns the associated object.
fnH5I_type_t H5Iregister_type(size_t hash_size, uint reserved, H5I_free_t free_func)Allocates a new identifier type.
fnherr_t H5Idestroy_type(H5I_type_t type)Destroys an identifier type.
fnvoid * H5Isearch(H5I_type_t type, H5I_search_func_t func, void * key)Searches through identifiers of a given type.
fnint H5Iget_type_ref(H5I_type_t type)Gets the reference count for an identifier type.
fnint H5Iinc_type_ref(H5I_type_t type)Increments the reference count for an identifier type.
fnint H5Idec_type_ref(H5I_type_t type)Decrements the reference count for an identifier type.
fnherr_t H5Iiterate(H5I_type_t type, H5I_iterate_func_t op, void * op_data)Iterates over all identifiers of a given type.
fnhid_t H5Iregister_future(H5I_type_t type, const void * object, H5I_future_realize_func_t realize_cb, H5I_future_discard_func_t discard_cb)Registers a "future" object and returns a new identifier for it.