var searchIndex = {};
searchIndex["hdf5_rs"] = {"doc":"","items":[[3,"Dataset","hdf5_rs","Represents the HDF5 dataset object.",null,null],[3,"File","","Represents the HDF5 file object.",null,null],[3,"Filters","","HDF5 filters and compression options.",null,null],[3,"Group","","Represents the HDF5 group object.",null,null],[3,"Dataspace","","Represents the HDF5 dataspace object.",null,null],[4,"Datatype","","Represents the HDF5 datatype object.",null,null],[13,"Integer","","",0,null],[13,"Float","","",0,null],[4,"Error","","The error type for HDF5-related functions.",null,null],[13,"LibraryError","","An error occurred in the C API of the HDF5 library. Full error stack is captured.",1,null],[13,"InternalError","","A user error occurred in the high-level Rust API (e.g., invalid user input).",1,null],[11,"shape","","Returns the shape of the dataset.",2,null],[11,"ndim","","Returns the number of dimensions in the dataset.",2,null],[11,"size","","Returns the total number of elements in the dataset.",2,null],[11,"is_scalar","","Returns whether this dataset is a scalar.",2,null],[11,"is_resizable","","Returns whether this dataset is resizable along some axis.",2,null],[11,"is_chunked","","Returns whether this dataset has a chunked layout.",2,null],[11,"is_type","","Returns whether this dataset's type is equivalent to the given type.",2,null],[11,"chunks","","Returns the chunk shape if the dataset is chunked.",2,null],[11,"filters","","Returns the filters used to create the dataset.",2,null],[11,"tracks_times","","Returns `true` if object modification time is tracked by the dataset.",2,null],[11,"storage_size","","Returns the amount of file space required for the dataset. Note that this only\naccounts for the space which has actually been allocated (it can be equal to zero).",2,null],[11,"offset","","Returns the absolute byte offset of the dataset in the file if such offset is defined\n(which is not the case for datasets that are chunked, compact or not allocated yet).",2,null],[11,"fill_value","","Returns default fill value for the dataset if such value is set. Note that conversion\nto the requested type is done by HDF5 which may result in loss of precision for\nfloating-point values if the datatype differs from the datatype of of the dataset.",2,null],[11,"datatype","","Returns a new `Datatype` object associated with this dataset.",2,null],[11,"eq","","",0,null],[11,"fmt","","",0,null],[11,"fmt","","",0,null],[11,"clone","","",1,null],[11,"query","","",1,{"inputs":[],"output":{"name":"option"}}],[11,"description","","",1,null],[11,"from","","",1,{"inputs":[{"name":"s"}],"output":{"name":"error"}}],[11,"fmt","","",1,null],[11,"fmt","","",1,null],[11,"description","","",1,null],[11,"open","","Create a new file object.",3,{"inputs":[{"name":"p"},{"name":"s"}],"output":{"name":"result"}}],[11,"size","","Returns the file size in bytes (or 0 if the file handle is invalid).",3,null],[11,"free_space","","Returns the free space in the file in bytes (or 0 if the file handle is invalid).",3,null],[11,"is_read_only","","Returns true if the file was opened in a read-only mode.",3,null],[11,"dump","","Returns the output of the `h5dump` tool. Note that this wouldn't work with core driver.",3,null],[11,"userblock","","Returns the userblock size in bytes (or 0 if the file handle is invalid).",3,null],[11,"flush","","Flushes the file to the storage medium.",3,null],[11,"close","","Closes the file and invalidates all open handles for contained objects.",3,null],[11,"fmt","","",3,null],[11,"fmt","","",3,null],[11,"fmt","","",4,null],[11,"eq","","",4,null],[11,"ne","","",4,null],[11,"clone","","",4,null],[11,"default","","",4,{"inputs":[],"output":{"name":"filters"}}],[11,"new","","",4,{"inputs":[],"output":{"name":"filters"}}],[11,"gzip","","Enable gzip compression with a specified level (0-9).",4,null],[11,"no_gzip","","Disable gzip compression.",4,null],[11,"get_gzip","","Get the current settings for gzip filter.",4,null],[11,"szip","","Enable szip compression with a specified method (EC, NN) and level (0-32).",4,null],[11,"no_szip","","Disable szip compression.",4,null],[11,"get_szip","","Get the current settings for szip filter.",4,null],[11,"shuffle","","Enable or disable shuffle filter.",4,null],[11,"get_shuffle","","Get the current settings for shuffle filter.",4,null],[11,"fletcher32","","Enable or disable fletcher32 filter.",4,null],[11,"get_fletcher32","","Get the current settings for fletcher32 filter.",4,null],[11,"scale_offset","","Enable scale-offset filter with a specified factor (0 means automatic).",4,null],[11,"no_scale_offset","","Disable scale_offset compression.",4,null],[11,"get_scale_offset","","Get the current settings for scale_offset filter.",4,null],[11,"gzip_default","","Enable gzip filter with default settings (compression level 4).",4,null],[11,"szip_default","","Enable szip filter with default settings (NN method, compression level 8).",4,null],[11,"has_filters","","Returns `true` if any filters are enabled and thus chunkins is required.",4,null],[11,"validate","","Verify whether the filters configuration is valid.",4,null],[11,"fmt","","",5,null],[11,"fmt","","",5,null],[11,"new","","",6,{"inputs":[{"name":"d"},{"name":"bool"}],"output":{"name":"result"}}],[11,"maxdims","","",6,null],[11,"resizable","","",6,null],[11,"ndim","","",6,null],[11,"dims","","",6,null],[11,"clone","","",6,null],[11,"fmt","","",6,null],[11,"fmt","","",6,null],[0,"prelude","","The HDF5 prelude module.",null,null],[8,"Object","hdf5_rs::prelude","A trait for all HDF5 objects that can be referenced through an identifier.",null,null],[11,"refcount","","Returns reference count if the handle is valid and 0 otherwise.",7,null],[11,"is_valid","","Returns `true` if the object has a valid unlocked identifier (`false` for pre-defined\nlocked identifiers like property list classes).",7,null],[11,"id_type","","Returns type of the object.",7,null],[8,"Location","","A trait for HDF5 objects that can have a named location (file, group, dataset).",null,null],[11,"name","","Returns the name of the object within the file, or empty string if the object doesn't\nhave a name (e.g., an anonymous dataset).",8,null],[11,"filename","","Returns the name of the file containing the named object (or the file itself).",8,null],[11,"file","","Returns a handle to the file containing the named object (or the file itself).",8,null],[11,"comment","","Returns the commment attached to the named object, if any.",8,null],[11,"set_comment","","Set or the commment attached to the named object.",8,null],[11,"clear_comment","","Clear the commment attached to the named object.",8,null],[8,"Container","","A trait for HDF5 objects that can contain other objects (file, group).",null,null],[11,"len","","Returns the number of objects in the container (or 0 if the container is invalid).",9,null],[11,"is_empty","","Returns true if the container has no linked objects (or if the container is invalid).",9,null],[11,"create_group","","Create a new group in a file or group.",9,null],[11,"group","","Opens an existing group in a file or group.",9,null],[11,"link_soft","","Creates a soft link. Note: `name` and `path` are relative to the current object.",9,null],[11,"link_hard","","Creates a hard link. Note: `name` and `path` are relative to the current object.",9,null],[11,"relink","","Relinks an object. Note: `name` and `path` are relative to the current object.",9,null],[11,"unlink","","Removes a link to an object from this file or group.",9,null],[11,"new_dataset","","Instantiates a new dataset builder.",9,null],[11,"dataset","","Opens an existing dataset in the file or group.",9,null],[8,"Dimension","","A trait for the shape and index types.",null,null],[10,"ndim","","",10,null],[10,"dims","","",10,null],[11,"size","","",10,null],[8,"ToDatatype","","A trait for native types that are convertible to HDF5 datatypes.",null,null],[10,"to_datatype","","",11,{"inputs":[],"output":{"name":"result"}}],[10,"from_raw_ptr","","",11,null],[10,"with_raw_ptr","","",11,{"inputs":[{"name":"self"},{"name":"f"}],"output":{"name":"t"}}],[8,"AnyDatatype","","A trait for all HDF5 datatypes.",null,null],[11,"size","","Get the total size of the datatype in bytes.",12,null],[8,"AtomicDatatype","","A trait for atomic scalar datatypes.",null,null],[11,"is_be","","Returns true if the datatype byte order is big endian.",13,null],[11,"is_le","","Returns true if the datatype byte order is little endian.",13,null],[11,"offset","","Get the offset of the first significant bit.",13,null],[11,"precision","","Get the number of significant bits, excluding padding.",13,null],[6,"Result","hdf5_rs","A type for results generated by HDF5-related functions where the `Err` type is\nset to `hdf5::Error`.",null,null],[6,"Ix","","A scalar integer type used by `Dimension` trait for indexing.",null,null],[8,"Container","","A trait for HDF5 objects that can contain other objects (file, group).",null,null],[11,"len","hdf5_rs::prelude","Returns the number of objects in the container (or 0 if the container is invalid).",9,null],[11,"is_empty","","Returns true if the container has no linked objects (or if the container is invalid).",9,null],[11,"create_group","","Create a new group in a file or group.",9,null],[11,"group","","Opens an existing group in a file or group.",9,null],[11,"link_soft","","Creates a soft link. Note: `name` and `path` are relative to the current object.",9,null],[11,"link_hard","","Creates a hard link. Note: `name` and `path` are relative to the current object.",9,null],[11,"relink","","Relinks an object. Note: `name` and `path` are relative to the current object.",9,null],[11,"unlink","","Removes a link to an object from this file or group.",9,null],[11,"new_dataset","","Instantiates a new dataset builder.",9,null],[11,"dataset","","Opens an existing dataset in the file or group.",9,null],[8,"ToDatatype","hdf5_rs","A trait for native types that are convertible to HDF5 datatypes.",null,null],[10,"to_datatype","","",11,{"inputs":[],"output":{"name":"result"}}],[10,"from_raw_ptr","","",11,null],[10,"with_raw_ptr","","",11,{"inputs":[{"name":"self"},{"name":"f"}],"output":{"name":"t"}}],[8,"Location","","A trait for HDF5 objects that can have a named location (file, group, dataset).",null,null],[11,"name","hdf5_rs::prelude","Returns the name of the object within the file, or empty string if the object doesn't\nhave a name (e.g., an anonymous dataset).",8,null],[11,"filename","","Returns the name of the file containing the named object (or the file itself).",8,null],[11,"file","","Returns a handle to the file containing the named object (or the file itself).",8,null],[11,"comment","","Returns the commment attached to the named object, if any.",8,null],[11,"set_comment","","Set or the commment attached to the named object.",8,null],[11,"clear_comment","","Clear the commment attached to the named object.",8,null],[8,"Object","hdf5_rs","A trait for all HDF5 objects that can be referenced through an identifier.",null,null],[11,"refcount","hdf5_rs::prelude","Returns reference count if the handle is valid and 0 otherwise.",7,null],[11,"is_valid","","Returns `true` if the object has a valid unlocked identifier (`false` for pre-defined\nlocked identifiers like property list classes).",7,null],[11,"id_type","","Returns type of the object.",7,null],[8,"Dimension","hdf5_rs","A trait for the shape and index types.",null,null],[10,"ndim","","",10,null],[10,"dims","","",10,null],[11,"size","hdf5_rs::prelude","",10,null],[14,"h5lock_s!","hdf5_rs","Run a safe expression in a closure synchronized by a global reentrant mutex.",null,null],[14,"h5lock!","","Run an unsafe expression in a closure synchronized by a global reentrant mutex.",null,null],[14,"h5call_s!","","",null,null],[14,"h5call!","","",null,null],[14,"h5try_s!","","",null,null],[14,"h5try!","","",null,null],[11,"len","hdf5_rs::prelude","Returns the number of objects in the container (or 0 if the container is invalid).",9,null],[11,"is_empty","","Returns true if the container has no linked objects (or if the container is invalid).",9,null],[11,"create_group","","Create a new group in a file or group.",9,null],[11,"group","","Opens an existing group in a file or group.",9,null],[11,"link_soft","","Creates a soft link. Note: `name` and `path` are relative to the current object.",9,null],[11,"link_hard","","Creates a hard link. Note: `name` and `path` are relative to the current object.",9,null],[11,"relink","","Relinks an object. Note: `name` and `path` are relative to the current object.",9,null],[11,"unlink","","Removes a link to an object from this file or group.",9,null],[11,"new_dataset","","Instantiates a new dataset builder.",9,null],[11,"dataset","","Opens an existing dataset in the file or group.",9,null],[11,"size","","Get the total size of the datatype in bytes.",12,null],[11,"is_be","","Returns true if the datatype byte order is big endian.",13,null],[11,"is_le","","Returns true if the datatype byte order is little endian.",13,null],[11,"offset","","Get the offset of the first significant bit.",13,null],[11,"precision","","Get the number of significant bits, excluding padding.",13,null],[11,"name","","Returns the name of the object within the file, or empty string if the object doesn't\nhave a name (e.g., an anonymous dataset).",8,null],[11,"filename","","Returns the name of the file containing the named object (or the file itself).",8,null],[11,"file","","Returns a handle to the file containing the named object (or the file itself).",8,null],[11,"comment","","Returns the commment attached to the named object, if any.",8,null],[11,"set_comment","","Set or the commment attached to the named object.",8,null],[11,"clear_comment","","Clear the commment attached to the named object.",8,null],[11,"refcount","","Returns reference count if the handle is valid and 0 otherwise.",7,null],[11,"is_valid","","Returns `true` if the object has a valid unlocked identifier (`false` for pre-defined\nlocked identifiers like property list classes).",7,null],[11,"id_type","","Returns type of the object.",7,null],[11,"size","","",10,null],[11,"ndim","hdf5_rs","",14,null],[11,"dims","","",14,null]],"paths":[[4,"Datatype"],[4,"Error"],[3,"Dataset"],[3,"File"],[3,"Filters"],[3,"Group"],[3,"Dataspace"],[8,"Object"],[8,"Location"],[8,"Container"],[8,"Dimension"],[8,"ToDatatype"],[8,"AnyDatatype"],[8,"AtomicDatatype"],[6,"Ix"]]};
initSearch(searchIndex);