Skip to main content

WatchConfig

Struct WatchConfig 

Source
pub struct WatchConfig {
    pub root: PathBuf,
    pub debounce: Duration,
    pub rag_override: Option<bool>,
    pub rag_delay: Duration,
    pub rag_config: EmbeddingProviderConfig,
    pub redact: RedactionConfig,
    pub json_events: bool,
    pub pid_lock_dir: Option<PathBuf>,
    pub pid_lock_slot: Option<String>,
    pub skip_migrations: bool,
    pub stale: Option<Arc<StaleState>>,
}
Expand description

Configuration for the watch loop.

Fields§

§root: PathBuf

Root directory to watch.

§debounce: Duration

Debounce window for filesystem events.

§rag_override: Option<bool>

Auto-embed override. Some(true)/Some(false) force on/off; None auto-detects (embed only if the DB already has embeddings). Resolved once at startup against the live DB — see run_watch.

§rag_delay: Duration

Delay after last index before embedding (only when auto-embed is on).

§rag_config: EmbeddingProviderConfig

RAG provider configuration (embedding + reranker).

§redact: RedactionConfig

Secret-redaction policy applied to each re-index pass.

§json_events: bool

Emit newline-delimited JSON events on stdout. When false, the loop only produces tracing logs on stderr (existing behavior).

§pid_lock_dir: Option<PathBuf>

Directory for the watcher’s PID file (written on startup, removed on graceful exit). None disables PID-file tracking. Consulted by cartog self update to detect a running watcher.

§pid_lock_slot: Option<String>

Slot name used when acquiring the watch PID file. Required when pid_lock_dir is set — run_watch/spawn_watch hard-fail if a directory is configured without a slot, to prevent a global-slot watcher from silently colliding with DB-scoped peers in multi-project setups. None is only valid when pid_lock_dir is also None (untracked mode used by tests).

In the cartog binary the slot is derived via cartog::state::slot_for_db("watch", db_path). Library embedders should follow the same shape: <prefix>-<16 hex chars> where the hex is a SHA-256 prefix of the canonicalized DB path.

§skip_migrations: bool

Open the on-disk DB via Database::open_existing_rw instead of Database::open. Used by the Phase 5 promoter to attach without re-running schema migrations (the promoter validated the schema when it pinned PinnedAttach; running them again would re-trigger the SQLITE_BUSY race the election prevents).

§stale: Option<Arc<StaleState>>

Shared staleness state for the MCP server to read. None (the default, e.g. standalone cartog watch) disables staleness publishing.

Implementations§

Source§

impl WatchConfig

Source

pub fn new(root: PathBuf) -> Self

Build a WatchConfig rooted at root with these defaults: debounce = 5s, rag_override = None (auto-detect), rag_delay = 30s, json_events = false, both pid_lock_* = None (untracked mode), skip_migrations = false. Callers wanting PID-lock tracking must set BOTH pid_lock_dir and pid_lock_slot after construction — see WatchConfig::pid_lock_slot.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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