Struct LockedLockfile 

pub struct LockedLockfile { /* private fields */ }

A module-lock.json held under its exclusive advisory lock.

The lock is released when this value is dropped, or when Self::write consumes it.

Implementations

impl LockedLockfile

pub fn read(path: &Path) -> Result<Option<Lockfile>, ProjectError>

Reads and parses the module-lock.json at path under a shared advisory lock.

Returns Ok(None) when the file is absent or empty. The file is never created, so reading cannot make a project appear to have a lockfile.

pub fn acquire(path: &Path) -> Result<Self, ProjectError>

Acquires the exclusive advisory lock on the module-lock.json at path, creating the file when it is absent.

This blocks until any other holder releases the lock.

pub fn current(&self) -> Result<Option<Lockfile>, ProjectError>

Returns the lockfile as it stands on disk under the held lock.

This is None when the file is empty, which is how a lockfile created solely to be locked reads.

pub fn write(self, lockfile: &Lockfile) -> Result<(), ProjectError>

Replaces the lockfile contents with lockfile and releases the lock.

The lockfile is serialized into memory first, so a serialization failure never reaches the file.

Trait Implementations

impl Debug for LockedLockfile

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

Formats the value using the given formatter.