Struct ScopedDirLock

pub struct ScopedDirLock { /* private fields */ }

Prove that a directory was locked.

Implementations

impl ScopedDirLock

pub fn new(path: &Path) -> Result<Self>

Lock the given directory with default options (exclusive, blocking).

pub fn new_with_options(dir: &Path, opts: &DirLockOptions) -> Result<Self>

Lock the given directory with advanced options.

• opts.file_name: decides the lock file name. A directory can have multiple locks independent from one another using different file_names.
• opts.non_blocking: if true, do not wait and return an error if lock cannot be obtained; if false, wait forever for the lock to be available.
• opts.exclusive: if true, ensure that no other locks are present for for the (dir, file_name); if false, allow other non-exclusive locks to co-exist.

pub fn path(&self) -> &Path

Get the path to the directory being locked.

Trait Implementations

impl Drop for ScopedDirLock

fn drop(&mut self)

Executes the destructor for this type.