ddn.lib.hdf5.h5l

HDF5 Link Binding

This module provides D bindings for HDF5 link operations (H5L API).

License

BSD-3-Clause

alias H5L_copy_func_t H5L_create_func_t H5L_delete_func_t H5L_iterate1_t H5L_iterate2_t H5L_move_func_t H5L_query_func_t H5L_traverse_func_t

enum H5_index_t H5_iter_order_t H5L_type_t

struct H5L_class_t H5L_info1_t H5L_info2_t H5O_token_t

fn H5Lcopy H5Lcreate_external H5Lcreate_hard H5Lcreate_soft H5Lcreate_ud H5Ldelete H5Ldelete_by_idx H5Lexists H5Lget_info1 H5Lget_info2 H5Lget_info_by_idx1 H5Lget_info_by_idx2 H5Lget_name_by_idx H5Lget_val H5Lget_val_by_idx H5Lis_registered H5Literate1 H5Literate2 H5Literate_by_name1 H5Literate_by_name2 H5Lmove H5Lregister H5Lunpack_elink_val H5Lunregister H5Lvisit1 H5Lvisit2 H5Lvisit_by_name1 H5Lvisit_by_name2

Types 15

enumH5L_type_t : int

Link type

ERROR = - 1

HARD = 0

SOFT = 1

EXTERNAL = 64

MAX = 255

enumH5_index_t : int

Index type

UNKNOWN = - 1

NAME = 0

CRT_ORDER = 1

N = 2

enumH5_iter_order_t : int

Iteration order

UNKNOWN = - 1

INC = 0

DEC = 1

NATIVE = 2

N = 3

structH5O_token_t

Object token (16 bytes)

Fields

ubyte[16] __data

structH5L_info2_t

Link information structure

Fields

H5L_type_t type

hbool_t corder_valid

long corder

int cset

aliasH5L_iterate2_t = herr_t function(hid_t group, const char * name, const H5L_info2_t * info, void * op_data)

Link iteration callback

structH5L_info1_t

Link information structure (version 1, deprecated)

Fields

H5L_type_t typeLink type

hbool_t corder_validCreation order valid flag

long corderCreation order

int csetCharacter set (H5Tcsett)

aliasH5L_iterate1_t = herr_t function(hid_t group, const char * name, const H5L_info1_t * info, void * op_data)

Link iteration callback (version 1, deprecated)

aliasH5L_traverse_func_t = hid_t function(const char * link_name, hid_t cur_group, const void * lnkdata, size_t lnkdata_size, hid_t lapl_id, hid_t dxpl_id) @nogc nothrow

Callback function type for user-defined link traversal.

This function is called when traversing a user-defined link.

Parameters

`link_name`	Name of the link being traversed
`cur_group`	Current group containing the link
`lnkdata`	User data stored with the link
`lnkdata_size`	Size of user data
`lapl_id`	Link access property list identifier
`udata`	User-supplied data for the callback

Returns

Object identifier on success, negative on failure.

aliasH5L_create_func_t = herr_t function(const char * link_name, hid_t loc_group, const void * lnkdata, size_t lnkdata_size, hid_t lcpl_id) @nogc nothrow

Callback function type for creating user-defined links.

Parameters

`link_name`	Name of the link being created
`loc_group`	Location identifier where link is being created
`lnkdata`	User data for the link
`lnkdata_size`	Size of user data
`lcpl_id`	Link creation property list identifier

Returns

Non-negative on success, negative on failure.

aliasH5L_move_func_t = herr_t function(const char * new_name, hid_t new_loc, const void * lnkdata, size_t lnkdata_size) @nogc nothrow

Callback function type for moving/renaming user-defined links.

Parameters

`new_name`	New name for the link
`new_loc`	New location identifier
`lnkdata`	User data stored with the link
`lnkdata_size`	Size of user data

Returns

Non-negative on success, negative on failure.

aliasH5L_copy_func_t = herr_t function(const char * new_name, hid_t new_loc, const void * lnkdata, size_t lnkdata_size) @nogc nothrow

Callback function type for copying user-defined links.

Parameters

`new_name`	Name for the copy
`new_loc`	Location identifier for the copy
`lnkdata`	User data stored with the link
`lnkdata_size`	Size of user data

Returns

Non-negative on success, negative on failure.

aliasH5L_delete_func_t = herr_t function(const char * link_name, hid_t file, const void * lnkdata, size_t lnkdata_size) @nogc nothrow

Callback function type for deleting user-defined links.

Parameters

`link_name`	Name of the link being deleted
`file`	File identifier containing the link
`lnkdata`	User data stored with the link
`lnkdata_size`	Size of user data

Returns

Non-negative on success, negative on failure.

aliasH5L_query_func_t = ssize_t function(const char * link_name, const void * lnkdata, size_t lnkdata_size, void * buf, size_t buf_size) @nogc nothrow

Callback function type for querying user-defined links.

Parameters

`link_name`	Name of the link being queried
`lnkdata`	User data stored with the link
`lnkdata_size`	Size of user data
`buf`	Buffer to receive query result
`buf_size`	Size of buffer

Returns

Size of query result on success, negative on failure.

structH5L_class_t

User-defined link class structure.

This structure defines the callbacks for a user-defined link type. Used with H5Lregister() to register custom link types.

Fields

int version_Version of this struct (use H5LLINKCLASSTVERS)

H5L_type_t idLink type identifier

const(char) * commentComment describing link type (for debugging)

H5L_create_func_t create_funcCallback to create link

H5L_move_func_t move_funcCallback to move/rename link

H5L_copy_func_t copy_funcCallback to copy link

H5L_traverse_func_t trav_funcCallback to traverse link

H5L_delete_func_t del_funcCallback to delete link

H5L_query_func_t query_funcCallback to query link

Functions 28

herr_t H5Lcreate_hard(hid_t cur_loc,  const  char *  cur_name,  hid_t dst_loc,
       const  char *  dst_name,  hid_t lcpl_id,  hid_t lapl_id)

Creates a hard link

herr_t H5Lcreate_soft(const  char *  link_target,  hid_t link_loc_id,
       const  char *  link_name,  hid_t lcpl_id,  hid_t lapl_id)

Creates a soft link

herr_t H5Lcreate_external(const  char *  file_name,  const  char *  obj_name,
       hid_t link_loc_id,  const  char *  link_name,  hid_t lcpl_id,  hid_t lapl_id)

Creates an external link

fnherr_t H5Ldelete(hid_t loc_id, const char * name, hid_t lapl_id)Deletes a link

herr_t H5Ldelete_by_idx(hid_t loc_id,  const  char *  group_name,  H5_index_t idx_type,
       H5_iter_order_t order,  hsize_t n,  hid_t lapl_id)

Deletes a link by index

fnhtri_t H5Lexists(hid_t loc_id, const char * name, hid_t lapl_id)Checks if link exists

fnherr_t H5Lget_info2(hid_t loc_id, const char * name, H5L_info2_t * linfo, hid_t lapl_id)Gets link information

fnherr_t H5Lget_val(hid_t loc_id, const char * name, void * buf, size_t size, hid_t lapl_id)Gets link value

ssize_t H5Lget_name_by_idx(hid_t loc_id,  const  char *  group_name,  H5_index_t idx_type,
       H5_iter_order_t order,  hsize_t n,  char *  name,  size_t size,  hid_t lapl_id)

Gets link name by index

herr_t H5Lmove(hid_t src_loc,  const  char *  src_name,  hid_t dst_loc,
       const  char *  dst_name,  hid_t lcpl_id,  hid_t lapl_id)

Moves a link

herr_t H5Lcopy(hid_t src_loc,  const  char *  src_name,  hid_t dst_loc,
       const  char *  dst_name,  hid_t lcpl_id,  hid_t lapl_id)

Copies a link

herr_t H5Literate2(hid_t grp_id,  H5_index_t idx_type,  H5_iter_order_t order,
       hsize_t *  idx,  H5L_iterate2_t op,  void *  op_data)

Iterates over links

herr_t H5Literate_by_name2(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t *  idx,
       H5L_iterate2_t op,  void *  op_data,  hid_t lapl_id)

Iterates over links by name

herr_t H5Lvisit2(hid_t grp_id,  H5_index_t idx_type,  H5_iter_order_t order,
       H5L_iterate2_t op,  void *  op_data)

Visits links recursively

herr_t H5Lget_info_by_idx2(hid_t loc_id,  const  char *  group_name,  H5_index_t idx_type,
       H5_iter_order_t order,  hsize_t n,  H5L_info2_t *  linfo,  hid_t lapl_id)

Gets link information by index.

herr_t H5Lget_val_by_idx(hid_t loc_id,  const  char *  group_name,  H5_index_t idx_type,
       H5_iter_order_t order,  hsize_t n,  void *  buf,  size_t size,  hid_t lapl_id)

Gets link value by index.

herr_t H5Lvisit_by_name2(hid_t loc_id,  const  char *  group_name,  H5_index_t idx_type,
       H5_iter_order_t order,  H5L_iterate2_t op,  void *  op_data,  hid_t lapl_id)

Visits links recursively by name.

herr_t H5Lunpack_elink_val(const  void *  ext_linkval,  size_t link_size,
       uint *  flags,  const  char * *  filename,  const  char * *  obj_path)

Unpacks an external link value.

herr_t H5Lcreate_ud(hid_t link_loc_id,  const  char *  link_name,  H5L_type_t link_type,
       const  void *  udata,  size_t udata_size,  hid_t lcpl_id,  hid_t lapl_id)

Creates a user-defined link.

fnhtri_t H5Lis_registered(H5L_type_t id)Checks if a user-defined link class is registered.

fnherr_t H5Lregister(const H5L_class_t * cls)Registers a user-defined link class.

fnherr_t H5Lunregister(H5L_type_t id)Unregisters a user-defined link class.

fnherr_t H5Lget_info1(hid_t loc_id, const char * name, H5L_info1_t * linfo, hid_t lapl_id)Gets link info (version 1, deprecated).

herr_t H5Lget_info_by_idx1(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t n,
       H5L_info1_t *  linfo,  hid_t lapl_id)

Gets link info by index (version 1, deprecated).

herr_t H5Literate1(hid_t grp_id,  H5_index_t idx_type,  H5_iter_order_t order,
       hsize_t *  idx,  H5L_iterate1_t op,  void *  op_data)

Iterates over links in a group (version 1, deprecated).

herr_t H5Literate_by_name1(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t *  idx,
       H5L_iterate1_t op,  void *  op_data,  hid_t lapl_id)

Iterates over links by name (version 1, deprecated).

herr_t H5Lvisit1(hid_t grp_id,  H5_index_t idx_type,  H5_iter_order_t order,
       H5L_iterate1_t op,  void *  op_data)

Visits links (version 1, deprecated).

herr_t H5Lvisit_by_name1(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,
       H5L_iterate1_t op,  void *  op_data,  hid_t lapl_id)

Visits links by name (version 1, deprecated).

Variables 1

enumvarH5L_LINK_CLASS_T_VERS = 1

Version number for H5L_class_t structure