Skip to main content

FileLock

Struct FileLock 

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

File lock manager for spec directories

Implementations§

Source§

impl FileLock

Source

pub fn acquire( spec_id: &str, force: bool, ttl_seconds: Option<u64>, ) -> Result<Self, LockError>

Attempt to acquire an exclusive lock for the given spec ID

Uses atomic O_EXCL/create_new semantics to prevent TOCTOU race conditions. If the lock file already exists, validates the existing lock before deciding whether to override it.

§Arguments
  • spec_id - The spec ID to lock
  • force - Whether to override stale locks
  • ttl_seconds - Time-to-live for lock staleness detection (None uses default)
§Returns
  • Ok(FileLock) - Successfully acquired lock
  • Err(LockError) - Failed to acquire lock (concurrent execution, stale lock, etc.)
Source

pub fn exists(spec_id: &str) -> bool

Check if a lock exists for the given spec ID

Source

pub fn get_lock_info(spec_id: &str) -> Result<Option<LockInfo>, LockError>

Get information about an existing lock (if any)

Source

pub fn release(self) -> Result<(), LockError>

Release the lock (called automatically on drop)

Source

pub fn spec_id(&self) -> &str

Get the spec ID for this lock

Source

pub const fn lock_info(&self) -> &LockInfo

Get the lock information

Trait Implementations§

Source§

impl Debug for FileLock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for FileLock

Source§

fn drop(&mut self)

Automatically release the lock when the FileLock is dropped

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.