Skip to main content

GroupNavigator

Struct GroupNavigator 

Source
pub struct GroupNavigator {
    pub root: ShdfGroup,
}
Expand description

Navigate an ShdfGroup hierarchy using HDF5-style slash-separated paths.

§Example

let mut root = ShdfGroup::new("root");
let mut sim  = ShdfGroup::new("simulation");
sim.add_dataset_f64("time", vec![3], vec![0.0, 0.5, 1.0]);
root.add_child(sim);
let nav = GroupNavigator::new(root);
assert!(nav.get_dataset("/simulation/time").is_some());

Fields§

§root: ShdfGroup

Root group of the hierarchy.

Implementations§

Source§

impl GroupNavigator

Source

pub fn new(root: ShdfGroup) -> Self

Create a navigator wrapping a root group.

Source

pub fn get_dataset(&self, path: &str) -> Option<&Dataset>

Resolve a slash-separated path such as "/root/simulation/atoms/positions" and return the terminal dataset if it exists.

The first path component must match the root group name.

Source

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

Return all dataset paths reachable from the root, in DFS order.

Source

pub fn total_datasets(&self) -> usize

Count total datasets reachable from the root.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.