Skip to main content

CommFileLock

Struct CommFileLock 

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

Advisory file lock for concurrent access to .acomm files.

Uses fs2 advisory locks so that multiple processes can safely read/write the same .acomm file without corruption. The sidecar lock file lives at <data_path>.acomm.lock.

Implementations§

Source§

impl CommFileLock

Source

pub fn acquire(data_path: &Path) -> CommResult<Self>

Acquire an exclusive lock on the .acomm file (blocks until available).

Source

pub fn try_acquire(data_path: &Path) -> CommResult<Self>

Try to acquire an exclusive lock without blocking.

Returns an error immediately if the lock is already held by another process.

Source

pub fn acquire_shared(data_path: &Path) -> CommResult<Self>

Acquire a shared (read) lock on the .acomm file (blocks until available).

Multiple readers can hold a shared lock simultaneously, but a shared lock blocks exclusive writers.

Source

pub fn release(self) -> CommResult<()>

Explicitly release the lock and attempt to clean up the lock file.

Source

pub fn recover_stale(data_path: &Path, max_age_secs: u64) -> CommResult<bool>

Check if the lock file is stale (older than max_age_secs seconds) and remove it if so.

Returns Ok(true) if a stale lock was recovered, Ok(false) otherwise.

Trait Implementations§

Source§

impl Drop for CommFileLock

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. 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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V