Enum FileLocking 

pub enum FileLocking {
    Enabled,
    Disabled,
    BestEffort,
}

Policy for OS advisory file locking when opening a file for editing.

The default is FileLocking::Enabled. The HDF5_USE_FILE_LOCKING environment variable, when set to a recognized value, overrides the requested policy (matching the reference HDF5 library): FALSE/0/NO/OFF disable locking, BEST_EFFORT selects best-effort, and TRUE/1/YES/ON enable it.

Variants

Enabled

Acquire the lock, and fail the open with Error::Io if the filesystem does not support locking. A lock held by another process always fails the open with Error::FileLocked.

Disabled

Do not attempt to lock the file at all.

BestEffort

Attempt to lock, but proceed without a lock when the filesystem reports that locking is unavailable (e.g. some NFS / network mounts). A lock that is genuinely held by another process still fails the open. Mirrors the reference library’s BEST_EFFORT / ignore_disabled_locks.

Trait Implementations

impl Clone for FileLocking

fn clone(&self) -> FileLocking

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FileLocking

impl Debug for FileLocking

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

Formats the value using the given formatter.

impl Default for FileLocking

fn default() -> FileLocking

Returns the “default value” for a type.

impl Eq for FileLocking

impl PartialEq for FileLocking

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