Struct MetadataCacheConfig 

pub struct MetadataCacheConfig { /* private fields */ }

Initial metadata-cache settings for streaming file access.

This is the hdf5-pure counterpart to the memory-budget portion of HDF5’s H5Pset_mdc_config: it bounds the bytes retained for parsed metadata reads while a file is opened through crate::File::open_streaming_with_options. Raw dataset payload reads use [FileSource::read_exact_at] and are not admitted to this cache.

Implementations

impl MetadataCacheConfig

pub const fn new(max_bytes: usize) -> Self

Create a metadata cache with the given total byte budget.

Individual cached reads are capped at [DEFAULT_METADATA_CACHE_MAX_ENTRY_BYTES] by default so one large heap or index block cannot monopolize the cache. Use with_max_entry_bytes to change that.

pub const fn disabled() -> Self

Disable metadata read caching.

pub const fn with_max_entry_bytes(self, max_entry_bytes: usize) -> Self

Set the maximum size of a single metadata read admitted to the cache.

pub const fn max_bytes(&self) -> usize

Return the total metadata-cache byte budget.

pub const fn max_entry_bytes(&self) -> usize

Return the maximum size of one cached metadata entry.

pub const fn is_enabled(&self) -> bool

Whether metadata read caching is enabled.

Trait Implementations

impl Clone for MetadataCacheConfig

fn clone(&self) -> MetadataCacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MetadataCacheConfig

impl Debug for MetadataCacheConfig

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

Formats the value using the given formatter.

impl Default for MetadataCacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MetadataCacheConfig

impl PartialEq for MetadataCacheConfig

fn eq(&self, other: &MetadataCacheConfig) -> 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 MetadataCacheConfig