Struct DatasetAccessProperties 

pub struct DatasetAccessProperties { /* private fields */ }

Dataset-access properties applied when opening a single dataset.

This is the hdf5-pure analogue of an HDF5 dataset access property list (dapl). Its chunk cache corresponds to H5Pset_chunk_cache: it overrides, for this one dataset, the file-wide chunk-cache default configured with FileAccessProperties::with_chunk_cache (the H5Pset_cache analogue). When left unset, the dataset inherits that file-wide default — matching the dapl default sentinels (H5D_CHUNK_CACHE_*_DEFAULT), which also mean “use the file’s setting”.

The Properties suffix means the type stands in for one whole HDF5 property list, so every setting on it has a C counterpart to look up. It is a stand-in and not a port: a plain Copy value, with no handle to create or close, no runtime property registry, and no setter that can fail. dapl and each H5Pset_* it models are doc aliases, so a search for either lands here. The chunk cache is the one dapl property modeled; see the property-support reference for the rest.

ChunkCacheConfig maps H5Pset_chunk_cache’s rdcc_nslots and rdcc_nbytes; its rdcc_w0 preemption policy is not modeled, because this read cache uses strict LRU eviction (as noted on ChunkCacheConfig::from_h5p_cache).

Pass it to File::dataset_with_options or Group::dataset_with_options.

Implementations

impl DatasetAccessProperties

pub const fn new() -> Self

A value that inherits every file-wide access default.

pub const fn with_chunk_cache(self, chunk_cache: ChunkCacheConfig) -> Self

Override the raw chunk cache for this one dataset, ignoring the file-wide default. This is the H5Pset_chunk_cache analogue.

pub const fn chunk_cache(&self) -> Option<ChunkCacheConfig>

Return the chunk-cache override, or None when the dataset inherits the file-wide default.

Trait Implementations

impl Clone for DatasetAccessProperties

fn clone(&self) -> DatasetAccessProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DatasetAccessProperties

impl Debug for DatasetAccessProperties

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

Formats the value using the given formatter.

impl Default for DatasetAccessProperties

fn default() -> DatasetAccessProperties

Returns the “default value” for a type.

impl Eq for DatasetAccessProperties

impl PartialEq for DatasetAccessProperties

fn eq(&self, other: &DatasetAccessProperties) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DatasetAccessProperties