Struct WriterLock 

pub struct WriterLock { /* private fields */ }

The workspace writer lock (writer.lock), released on drop.

Implementations

impl WriterLock

pub fn path_in(omgbase_dir: &Path) -> PathBuf

The lock file’s path under omgbase_dir.

pub fn try_acquire(omgbase_dir: &Path) -> Result<Option<Self>>

Take the lock without waiting; None when a live writer holds it.

pub fn acquire(omgbase_dir: &Path, opts: WriterLockOptions) -> Result<Self>

Take the lock, polling until free or the timeout elapses (Error::WriterLockTimeout naming the holder).

pub fn is_free(omgbase_dir: &Path) -> bool

Whether no live writer holds the lock (a probe; acquires nothing).

pub fn path(&self) -> &Path

pub fn release(&mut self)

Unlink the lock file (best effort; idempotent).

Trait Implementations

impl Debug for WriterLock

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

Formats the value using the given formatter.

impl Drop for WriterLock

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.