Skip to main content

DirLock

Struct DirLock 

Source
pub struct DirLock { /* private fields */ }
Expand description

An advisory exclusive lock on a ForgeDB data directory.

Holds an open File to <root>/.forgedb.lock with an OS-level exclusive advisory lock (via fs2::FileExt::try_lock_exclusive). The lock is released automatically when this value is dropped (the File closes, which the OS uses to release the advisory lock).

§Acquiring

use forgedb_storage_native::DirLock;
use std::path::Path;

let lock = DirLock::acquire(Path::new("./data"))?;
// lock is held for the lifetime of the value
drop(lock); // released here

§Conflicts

If another process already holds the lock, acquire returns Err with kind() == io::ErrorKind::WouldBlock. The caller should print a human-readable message and exit:

use forgedb_storage_native::DirLock;
use std::path::Path;

match DirLock::acquire(Path::new("./data")) {
    Ok(lock) => { /* proceed */ }
    Err(e) if e.kind() == std::io::ErrorKind::WouldBlock => {
        eprintln!("error: another ForgeDB writer already has this data directory open");
        std::process::exit(1);
    }
    Err(e) => return Err(e),
}

Implementations§

Source§

impl DirLock

Source

pub fn acquire(root: &Path) -> Result<DirLock, Error>

Try to acquire an exclusive advisory lock on <root>/.forgedb.lock, creating the file (and any missing parent directories) if needed.

Returns Ok(DirLock) on success. If another process already holds the lock, returns Err with kind() == io::ErrorKind::WouldBlock so the caller can print a clear “another writer already has this data dir open” message and exit.

§Errors
  • WouldBlock — another process already holds the exclusive lock.
  • Any other io::Error from creating the directory or opening the file.

Trait Implementations§

Source§

impl Debug for DirLock

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.