Struct named_lock::NamedLock

pub struct NamedLock { /* private fields */ }

Cross-process lock that is identified by name.

Implementations

impl NamedLock

pub fn create(name: &str) -> Result<NamedLock>

Create/open a named lock.

UNIX

This will create/open a file and use flock on it. The path of the lock file will be $TMPDIR/<name>.lock, or /tmp/<name>.lock if TMPDIR environment variable is not set.

If you want to specify the exact path, then use NamedLock::with_path.

Windows

This will create/open a global mutex with CreateMutexW.

Notes

• name must not be empty, otherwise an error is returned.
• name must not contain \0, /, nor \, otherwise an error is returned.

pub fn with_path<P>(path: P) -> Result<NamedLock>where
    P: AsRef<Path>,

Available on Unix only.

Create/open a named lock on specified path.

Notes

• This function does not append .lock on the path.
• Parent directories must exist.

pub fn try_lock(&self) -> Result<NamedLockGuard<'_>>

Try to lock named lock.

If it is already locked, Error::WouldBlock will be returned.

pub fn lock(&self) -> Result<NamedLockGuard<'_>>

Lock named lock.

Trait Implementations

impl Debug for NamedLock

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

Formats the value using the given formatter.