Configuration

HDF5.has_ros3Function
has_ros3()

Returns true if the HDF5 libraries were compiled with ros3 support

source

Display

HDF5.SHOW_TREE_ICONSConstant
SHOW_TREE_ICONS = Ref{Bool}(true)

Configurable option to control whether emoji icons (true) or a plain-text annotation (false) is used to indicate the object type by show_tree.

source

Internals

HDF5.get_context_propertyFunction
get_context_property(name::Symbol)

Internal API

Retrieve a property list from the task local context, defaulting to HDF5.CONTEXT if task_local_storage()[:hdf5_context] does not exist.

source
HDF5.HDF5ContextType
HDF5Context

Internal API

An HDF5Context is a collection of HDF5 property lists. It is meant to be used as a Task local mechanism to store state and change the default property lists for new objects.

Use the function get_context_property(name::Symbol) to access a property list within the local context.

The context in task_local_storage()[:hdf5_context] will be checked first. A common global HDF5Context is stored in the constant HDF5.CONTEXT and serves as the default context if the current task does not have a :hdf5_context.

Fields

  • attribute_access
  • attribute_create
  • dataset_access
  • dataset_create
  • dataset_tranfer
  • datatype_access
  • datatype_create
  • file_access
  • file_create
  • file_mount
  • group_access
  • group_create
  • link_access
  • link_create
  • object_copy
  • object_create
  • string_create
source

System Libraries

HDF5.API.set_libraries!Function
set_libraries!(libhdf5 = nothing, libhdf5_hl = nothing; force = true)

Convenience function to set the preferences for a system-provided HDF5 library. Pass the paths pointing to the libraries libhdf5 and libhdf5_hl as strings to set the preference. If libhdf5 and libhdf5_hl are nothing use the default, i.e. the binaries provided by HDF5_jll.jl.

source