Enum FileLocking 

pub enum FileLocking {
    Enabled,
    Disabled,
    BestEffort,
}

File-locking policy applied at file open time.

Variants

Enabled

Acquire the lock; fail to open if it cannot be acquired (the HDF5 C-library default).

Disabled

Skip locking entirely.

BestEffort

Try to acquire the lock; on failure (filesystem doesn’t support locking, or another holder), proceed without one. Useful on NFS and similar filesystems.

Implementations

impl FileLocking

pub fn from_env() -> Self

Returns the policy implied by the HDF5_USE_FILE_LOCKING environment variable, falling back to FileLocking::Enabled.

pub fn from_env_or(default: FileLocking) -> Self

Returns the policy implied by the env var if set, otherwise default.

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 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 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 Copy for FileLocking

impl Eq for FileLocking

impl StructuralPartialEq for FileLocking