Struct Hdf5File 

pub struct Hdf5File { /* private fields */ }

An opened HDF5 file.

This is the main entry point for reading HDF5 files. Storage is random- access and range-based, so metadata and data reads do not require an eager whole-file mapping.

Implementations

impl Hdf5File

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open an HDF5 file with default options.

pub fn open_with_options( path: impl AsRef<Path>, options: OpenOptions, ) -> Result<Self>

Open an HDF5 file with custom options.

pub fn from_bytes(data: &[u8]) -> Result<Self>

Open an HDF5 file from an in-memory byte slice.

The data is copied into an owned buffer.

pub fn from_bytes_with_options( data: &[u8], options: OpenOptions, ) -> Result<Self>

Open an HDF5 file from an in-memory byte slice with custom options.

The data is copied into an owned buffer.

pub fn from_vec(data: Vec<u8>) -> Result<Self>

Open an HDF5 file from an owned byte vector without copying.

pub fn from_vec_with_options( data: Vec<u8>, options: OpenOptions, ) -> Result<Self>

Open an HDF5 file from an owned byte vector with custom options.

pub fn from_mmap_with_options(mmap: Mmap, options: OpenOptions) -> Result<Self>

Open an HDF5 file from an existing memory map with custom options.

This avoids remapping when the caller already owns a read-only mapping.

pub fn from_storage(storage: DynStorage) -> Result<Self>

Open an HDF5 file from a custom random-access storage backend.

pub fn from_storage_with_options( storage: DynStorage, options: OpenOptions, ) -> Result<Self>

Open an HDF5 file from a custom random-access storage backend.

pub fn superblock(&self) -> &Superblock

Get the parsed superblock.

pub fn storage(&self) -> &dyn Storage

Access the underlying random-access storage backend.

pub fn get_or_parse_header(&self, addr: u64) -> Result<Arc<ObjectHeader>>

Look up or parse an object header at the given address.

Uses the internal cache to avoid re-parsing the same header.

pub fn root_group(&self) -> Result<Group>

Get the root group of the file.

pub fn dataset(&self, path: &str) -> Result<Dataset>

Convenience: get a dataset at a path like “/group1/dataset”.

pub fn group(&self, path: &str) -> Result<Group>

Convenience: get a group at a path like “/group1/subgroup”.

Trait Implementations

impl Clone for Hdf5File

fn clone(&self) -> Hdf5File

Returns a duplicate of the value.

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

Performs copy-assignment from source.