Skip to main content

FileAccessOptions

Struct FileAccessOptions 

Source
pub struct FileAccessOptions { /* private fields */ }
Expand description

File-access options applied when opening an HDF5 file.

This is the hdf5-pure analogue of the HDF5 file access property list settings relevant to read-time memory usage. The metadata cache only affects streaming opens; in-memory opens already have the whole file in one buffer. The chunk cache is the file-wide default corresponding to HDF5 H5Pset_cache’s raw-data chunk-cache settings and applies to datasets opened from either backend.

Implementations§

Source§

impl FileAccessOptions

Source

pub const fn new() -> Self

Create options with the crate’s default access behavior.

Source

pub const fn with_metadata_cache( self, metadata_cache: MetadataCacheConfig, ) -> Self

Configure the bounded streaming metadata cache.

Source

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

Configure the per-dataset raw chunk cache used by datasets opened from this file. This is the H5Pset_cache-style file-wide default.

Source

pub const fn metadata_cache(&self) -> MetadataCacheConfig

Return the configured streaming metadata cache.

Source

pub const fn chunk_cache(&self) -> ChunkCacheConfig

Return the configured per-dataset chunk cache.

Trait Implementations§

Source§

impl Clone for FileAccessOptions

Source§

fn clone(&self) -> FileAccessOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FileAccessOptions

Source§

impl Debug for FileAccessOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FileAccessOptions

Source§

fn default() -> FileAccessOptions

Returns the “default value” for a type. Read more
Source§

impl Eq for FileAccessOptions

Source§

impl PartialEq for FileAccessOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for FileAccessOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.