Struct H5FileOptions 

pub struct H5FileOptions { /* private fields */ }

Builder controlling how an H5File is opened.

The default policy follows the HDF5 C library: an exclusive lock is acquired for write-mode opens and a shared lock for read-mode opens, honoring the HDF5_USE_FILE_LOCKING environment variable. Calling Self::locking overrides the env-var value.

Implementations

impl H5FileOptions

pub fn new() -> Self

Construct a fresh options builder with default settings.

pub fn locking(self, policy: FileLocking) -> Self

Override the locking policy. Bypasses the HDF5_USE_FILE_LOCKING environment variable for the resulting open call.

pub fn no_locking(self) -> Self

Disable OS-level file locking entirely (equivalent to HDF5_USE_FILE_LOCKING=FALSE).

pub fn best_effort_locking(self) -> Self

Try to acquire the lock but do not fail if the filesystem rejects it (equivalent to HDF5_USE_FILE_LOCKING=BEST_EFFORT).

pub fn create<P: AsRef<Path>>(self, path: P) -> Result<H5File>

Create a new HDF5 file at path with the configured options.

pub fn open<P: AsRef<Path>>(self, path: P) -> Result<H5File>

Open an existing HDF5 file for reading with the configured options.

pub fn open_rw<P: AsRef<Path>>(self, path: P) -> Result<H5File>

Open an existing HDF5 file for read/write with the configured options.

Trait Implementations

impl Clone for H5FileOptions

fn clone(&self) -> H5FileOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for H5FileOptions

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

Formats the value using the given formatter.

impl Default for H5FileOptions

fn default() -> H5FileOptions

Returns the “default value” for a type.