Skip to main content

HDF5Group

Struct HDF5Group 

Source
pub struct HDF5Group { /* private fields */ }
Expand description

An HDF5 group — a container for datasets and other groups.

Groups can be navigated by name (like a filesystem). Internally, HDF5 uses two completely different mechanisms depending on the object header version:

  • v1 groups: Symbol table message → B-tree v1 (type 0) + local heap for names
  • v2 groups: Inline link messages (small groups) or link info message → fractal heap + B-tree v2 (large groups)

Implementations§

Source§

impl HDF5Group

Source

pub fn new( name: String, header: ObjectHeader, reader: Arc<dyn AsyncFileReader>, raw_reader: Arc<dyn AsyncFileReader>, superblock: Arc<Superblock>, ) -> Self

Create a new group from its parsed object header.

Source

pub fn name(&self) -> &str

The group’s name (not the full path).

Source

pub fn header(&self) -> &ObjectHeader

Access the object header.

Source

pub async fn children(&self) -> Result<Vec<ChildLink>>

List all child links in this group.

Source

pub async fn group(&self, name: &str) -> Result<HDF5Group>

Get a child group by name.

Source

pub async fn dataset(&self, name: &str) -> Result<HDF5Dataset>

Get a child dataset by name.

Source

pub async fn child_header(&self, name: &str) -> Result<(u64, ObjectHeader)>

Get a child’s object header by name (returns the header without assuming whether it’s a group or dataset).

Source

pub async fn navigate(&self, path: &str) -> Result<HDF5Group>

Navigate to a group by slash-separated path (e.g., “science/LSAR/GCOV”).

Source

pub async fn group_names(&self) -> Result<Vec<String>>

List all child group names.

Source

pub async fn dataset_names(&self) -> Result<Vec<String>>

List all child dataset names.

Source

pub fn reader(&self) -> &Arc<dyn AsyncFileReader>

Access the reader.

Source

pub fn superblock(&self) -> &Arc<Superblock>

Access the superblock.

Source

pub async fn attributes(&self) -> Vec<Attribute>

Get all attributes attached to this group, resolving vlen data.

Source

pub async fn attribute(&self, name: &str) -> Option<Attribute>

Get a single attribute by name.

Trait Implementations§

Source§

impl Debug for HDF5Group

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more