Struct DatasetAccessOptions 

pub struct DatasetAccessOptions { /* private fields */ }

Dataset-access options 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 FileAccessOptions::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”.

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 DatasetAccessOptions

pub const fn new() -> Self

Create options that inherit 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 DatasetAccessOptions

fn clone(&self) -> DatasetAccessOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DatasetAccessOptions

impl Debug for DatasetAccessOptions

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

Formats the value using the given formatter.

impl Default for DatasetAccessOptions

fn default() -> DatasetAccessOptions

Returns the “default value” for a type.

impl Eq for DatasetAccessOptions

impl PartialEq for DatasetAccessOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DatasetAccessOptions