Struct Hdf5Layout 

pub struct Hdf5Layout {
    pub groups: Vec<LayoutGroup>,
    pub detector_data_destination: Option<String>,
}

The parsed HDF5 layout tree (<hdf5_layout> root).

Fields

groups: Vec<LayoutGroup>

Top-level groups.

detector_data_destination: Option<String>

<global name="detector_data_destination" ndattribute="..."/>.

Implementations

impl Hdf5Layout

pub fn from_file(path: &Path) -> Result<Hdf5Layout, LayoutError>

Parse a layout XML file from disk.

pub fn parse(text: &str) -> Result<Hdf5Layout, LayoutError>

Parse a layout XML document from a string.

pub fn for_each_dataset<F: FnMut(&str, &LayoutDataset)>(&self, f: F)

Walk every dataset in the tree, yielding (full_group_path, dataset).

pub fn detector_dataset_path(&self) -> Option<String>

Find the dataset flagged det_default, returning its full path.

pub fn detector_dataset_paths(&self) -> Vec<String>

Enumerate every detector-source dataset’s full path (leading slash), in document order. C NDFileHDF5 holds one NDFileHDF5Dataset per <dataset source="detector"> node in detDataMap, each created by createDatasetDetector (NDFileHDF5.cpp:1324-1357) and keyed by get_full_name() — the same leading-slash full path produced here. The writer creates all of them up front and routes each frame to one of them by the detector_data_destination NDAttribute.

pub fn dataset_group_path(&self, name: &str) -> Option<String>

Find the group path of the first dataset named name, returning the owning group’s full path (the C NDFileHDF5 performance dataset is a <dataset name="timestamp"> in the layout tree).

pub fn ndattribute_dataset(&self, name: &str) -> Option<(String, String)>

Find the layout <dataset source="ndattribute" ndattribute="name"> declared for the NDAttribute name, returning (parent group full path, dataset name). C find_dset_ndattr (NDFileHDF5.cpp:2792) routes a matching NDAttribute into its XML-declared dataset/group instead of the default attribute group.

pub fn ndattribute_element_attrs(&self) -> Vec<NdAttrElementAttr>

Enumerate every <attribute source="ndattribute"> declared on a group or dataset in the tree, in document order, with the owning element’s full path. C storeOnOpenCloseAttribute (NDFileHDF5.cpp:553-632) writes each as an HDF5 attribute on its element, sourcing the value from the live NDAttribute (get_attributes() over groups and datasets).

pub fn ndattr_default_group(&self) -> Option<String>

Find the group flagged ndattr_default, returning its full path.

Trait Implementations

impl Clone for Hdf5Layout

fn clone(&self) -> Hdf5Layout

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Hdf5Layout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Hdf5Layout

fn default() -> Hdf5Layout

Returns the “default value” for a type.