Struct Lock 

pub struct Lock { /* private fields */ }

A cross-process named lock.

Lock is a lightweight handle backed by an Arc; cloning it is O(1) and all clones share the same underlying state — including the process-level mutual-exclusion guarantee.

Name rules

• Must not be empty.
• Must not contain \0, /, or \.

Implementations

impl Lock

pub fn new(name: &str) -> Result<Self>

Open (or create) a named lock identified by name.

Platform behaviour

• Unix — creates/opens $TMPDIR/<name>.lock (falls back to /tmp/<name>.lock when TMPDIR is unset).
• Windows — creates/opens a kernel mutex named Global\<name>.

Errors

Returns Error::InvalidName for illegal names, or Error::Io if the OS operation fails.

pub fn with_path<P: AsRef<Path>>(path: P) -> Result<Self>

Available on Unix only.

Open (or create) a named lock at an explicit filesystem path.

Unlike Lock::new, no .lock suffix is appended and the location is not constrained to $TMPDIR. Parent directories must already exist.

Errors

Returns Error::Io if the path cannot be opened or created.

pub fn path(&self) -> &Path

Available on Unix only.

Return the filesystem path of the backing lock file (Unix only).

This is the path used by Lock::new or Lock::with_path. It can be used by callers to clean up the lock file when they know it is safe to do so. The library itself intentionally leaves the file in place; deleting it while another process may still be using the lock can break mutual exclusion.

pub fn lock(&self) -> Result<LockGuard>

Acquire the lock, blocking until it is available.

Returns a LockGuard that releases the lock when dropped.

Errors

Returns Error::Io if the underlying OS call fails.

pub fn try_lock(&self) -> Result<LockGuard>

Try to acquire the lock without blocking.

Returns a LockGuard if the lock is free, or Error::WouldBlock if it is currently held.

Errors

Returns Error::WouldBlock when the lock is held, or Error::Io for any other OS-level failure.

Trait Implementations

impl Clone for Lock

fn clone(&self) -> Lock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lock

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

Formats the value using the given formatter.