Skip to main content

LoopLock

Struct LoopLock 

Source
pub struct LoopLock;
Expand description

The loop lock mechanism.

Uses flock() to provide advisory locking on .ralph/loop.lock. The lock is automatically released when the process exits (even on crash).

Implementations§

Source§

impl LoopLock

Source

pub const LOCK_FILE: &'static str = ".ralph/loop.lock"

The relative path to the lock file within the workspace.

Source

pub fn try_acquire( workspace_root: impl AsRef<Path>, prompt: &str, ) -> Result<LockGuard, LockError>

Try to acquire the loop lock (non-blocking).

§Arguments
  • workspace_root - Root directory of the workspace
  • prompt - The prompt/task being executed (stored in lock metadata)
§Returns
  • Ok(LockGuard) - Lock acquired successfully
  • Err(LockError::AlreadyLocked(metadata)) - Another process holds the lock
  • Err(LockError::Io(_)) - IO error
Source

pub fn acquire_blocking( workspace_root: impl AsRef<Path>, prompt: &str, ) -> Result<LockGuard, LockError>

Acquire the loop lock, blocking until available.

This should be used with the --exclusive flag to wait for the primary loop slot instead of spawning into a worktree.

§Arguments
  • workspace_root - Root directory of the workspace
  • prompt - The prompt/task being executed
§Returns
  • Ok(LockGuard) - Lock acquired successfully
  • Err(LockError::Io(_)) - IO error
Source

pub fn read_existing( workspace_root: impl AsRef<Path>, ) -> Result<Option<LockMetadata>, LockError>

Read the metadata from an existing lock file.

This can be used to check who holds the lock without acquiring it.

Source

pub fn is_locked(workspace_root: impl AsRef<Path>) -> Result<bool, LockError>

Check if the lock is currently held (without acquiring it).

Returns true if another process holds the lock.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more