Struct Dataset 

pub struct Dataset { /* private fields */ }

A dataset within an HDF5 file.

Implementations

impl Dataset

pub fn name(&self) -> &str

Dataset name.

pub fn address(&self) -> u64

The object header address used to parse this dataset. Useful as an opaque identifier or for NC4 data_offset.

pub fn shape(&self) -> &[u64]

Shape of the dataset (dimensions).

pub fn dtype(&self) -> &Datatype

Datatype of the dataset.

pub fn ndim(&self) -> usize

Number of dimensions.

pub fn max_dims(&self) -> Option<&[u64]>

Maximum dimension sizes, if defined. u64::MAX indicates unlimited.

pub fn chunks(&self) -> Option<Vec<u32>>

Chunk dimensions, if the dataset is chunked.

pub fn iter_chunks(&self) -> Result<DatasetChunkIterator>

Iterate over decoded chunks for a chunked dataset.

pub fn chunk_cache_stats(&self) -> ChunkCacheStats

Return current chunk-cache statistics for this dataset’s file.

pub fn fill_value(&self) -> Option<&FillValueMessage>

Fill value, if defined.

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

Dataset attributes.

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

Find an attribute by name.

pub fn read_string(&self) -> Result<String>

Read a scalar string dataset or single string element.

Use Dataset::read_strings when the dataset contains multiple strings.

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

Read all string elements from a string-typed dataset.

pub fn num_elements(&self) -> u64

Total number of elements in the dataset.

pub fn read_array<T: H5Type>(&self) -> Result<ArrayD<T>>

Read the entire dataset into an n-dimensional array.

pub fn read_into<T: H5Type>(&self, dst: &mut [T]) -> Result<()>

Read the entire dataset into a caller-provided typed buffer.

pub fn read_array_parallel<T: H5Type>(&self) -> Result<ArrayD<T>>

Read the entire dataset using internal chunk-level parallelism when possible.

Non-chunked datasets fall back to read_array.

pub fn read_array_in_pool<T: H5Type>( &self, pool: &ThreadPool, ) -> Result<ArrayD<T>>

Read the entire dataset using the provided Rayon thread pool.

Non-chunked datasets fall back to read_array.

pub fn read_slice_parallel<T: H5Type>( &self, selection: &SliceInfo, ) -> Result<ArrayD<T>>

Read a hyperslab of the dataset using chunk-level parallelism when possible.

Chunked datasets decompress overlapping chunks in parallel via Rayon. Non-chunked layouts fall back to read_slice.

pub fn read_slice<T: H5Type>(&self, selection: &SliceInfo) -> Result<ArrayD<T>>

Read a hyperslab of the dataset.

pub fn read_raw_bytes(&self) -> Result<Vec<u8>>

Read the dataset as logical element bytes.

The returned bytes are after layout handling, chunk decompression, filter decoding, external raw-data resolution, and fill-value materialization. Numeric values remain in the dataset datatype’s byte order.

pub fn raw_byte_len(&self) -> Result<usize>

Number of logical raw bytes in the entire dataset.

pub fn read_raw_bytes_into(&self, dst: &mut [u8]) -> Result<()>

Read logical raw bytes into a caller-provided buffer.

The destination length must match Dataset::raw_byte_len. Numeric values remain in the dataset datatype’s byte order.

pub fn read_native_bytes(&self) -> Result<Vec<u8>>

Read logical raw bytes converted to native-endian numeric fields.

pub fn read_native_bytes_into(&self, dst: &mut [u8]) -> Result<()>

Read logical raw bytes into a buffer and convert numeric fields to native endian.

pub fn vlen_reference_size(&self) -> usize

Size in bytes of one HDF5 variable-length reference in this file.

pub fn raw_element_size(&self) -> usize

Size in bytes of one logical raw element in this file.

Variable-length strings and sequences are stored as global-heap references whose width depends on the file offset size.

pub fn resolve_vlen_reference_bytes( &self, reference: &[u8], base_element_size: usize, ) -> Result<Vec<u8>>

Resolve one HDF5 variable-length reference into logical element bytes.

base_element_size is the byte width of one value in the vlen sequence. The sequence length stored in the reference is interpreted as an element count and multiplied by this size.

Trait Implementations

impl Clone for Dataset

fn clone(&self) -> Dataset

Returns a duplicate of the value.

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

Performs copy-assignment from source.