Struct advisory_lock::AdvisoryFileLock

pub struct AdvisoryFileLock { /* fields omitted */ }

An advisory lock for files.

An advisory lock provides a mutual-exclusion mechanism among processes which explicitly acquires and releases the lock. Processes that are not aware of the lock will ignore it.

AdvisoryFileLock provides following features:

• Blocking or non-blocking operations.
• Shared or exclusive modes.
• All operations are thread-safe.

Notes

AdvisoryFileLock has following limitations:

• Locks are allowed only on files, but not directories.

Implementations

impl AdvisoryFileLock

pub fn new<P: AsRef<Path>>(
    path: P,
    file_lock_mode: FileLockMode
) -> Result<Self, FileLockError>

Create a new FileLock.

pub fn is_shared(&self) -> bool

Return true if the advisory lock is acquired by shared mode.

pub fn is_exclusive(&self) -> bool

Return true if the advisory lock is acquired by exclusive mode.

pub fn lock(&mut self) -> Result<(), FileLockError>

Acquire the advisory file lock.

lock is blocking; it will block the current thread until it succeeds or errors.

pub fn try_lock(&mut self) -> Result<(), FileLockError>

Try to acquire the advisory file lock.

try_lock returns immediately.

pub fn unlock(&mut self) -> Result<(), FileLockError>

Trait Implementations

impl Drop for AdvisoryFileLock

fn drop(&mut self)

Executes the destructor for this type.