Struct brane_shr::fs::FileLock

pub struct FileLock { /* private fields */ }

Defines a wrapper around a file handle that can be used to implement file locks.

Implementations

impl FileLock

pub fn lock( name: impl AsRef<str>, version: impl AsRef<Version>, path: impl Into<PathBuf>, ) -> Result<Self, Error>

Constructor for the FileLock that attempts to lock the given file.

This function will block until it becomes available.

Note that this lock is an exclusive lock.

Arguments

• name: The name of the package for which we are waiting.
• version: The version of the package for which we are waiting.
• path: The path of the file to use a lockfile.

Returns

A new instance of the FileLock that acts as a guard of the lock. As long as it’s in scope, the exclusive lock will be held.

pub fn release(self)

Releases this file lock.

This works by simply consuming ourself, forcing a drop.

Trait Implementations

impl Debug for FileLock

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

Formats the value using the given formatter.

impl Drop for FileLock

fn drop(&mut self)

Executes the destructor for this type.