Skip to main content

IndexManager

Struct IndexManager 

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

Index manager that handles index lifecycle and file watching.

Provides two-phase initialization:

  1. new() - Load or refresh index at startup
  2. start_file_watcher() - Start background file watching

Implementations§

Source§

impl IndexManager

Source

pub async fn new<P: AsRef<Path>>( codebase_path: P, stores: Arc<SharedStores>, ) -> Result<Self>

Create a new index manager with shared stores.

This is the first method call - should be called at server startup.

§Arguments
  • codebase_path - Path to the codebase to index
  • stores - Shared stores for concurrent access (created by caller)
§Returns
  • Result<Self> - Index manager instance or error
§Behavior
  • Checks if index exists and is up-to-date
  • ERROR if index doesn’t exist - user must run codesearch index add first
  • If index exists, performs incremental refresh
  • Logs all operations with detailed info
§Errors
  • Returns error if index doesn’t exist (user must create index first)
Source

pub fn stores(&self) -> Arc<SharedStores>

Get a reference to the shared stores (for CodesearchService)

Source

pub async fn new_without_refresh<P: AsRef<Path>>( codebase_path: P, stores: Arc<SharedStores>, ) -> Result<Self>

Create a new index manager WITHOUT performing incremental refresh.

Use this when the caller has already performed the refresh (e.g., MCP server). This avoids FTS lock conflicts by allowing the caller to control when the refresh happens relative to SharedStores creation.

§Arguments
  • codebase_path - Path to the codebase to index
  • stores - Shared stores for concurrent access (created by caller)
Source

pub async fn perform_incremental_refresh_with_stores( codebase_path: &Path, db_path: &Path, stores: &SharedStores, ) -> Result<()>

Perform incremental refresh using shared stores.

This checks for changed/deleted files since last index and updates the index accordingly. Uses the shared stores to avoid lock conflicts.

Source

pub async fn start_watching(&self) -> Result<()>

Start the file system watcher (begin collecting events) without starting the processing loop.

Call this BEFORE a long-running operation (like incremental refresh) to capture file changes that happen during that operation. Then call start_file_watcher() afterwards to begin processing the buffered events.

Source

pub async fn start_file_watcher( &self, cancel_token: CancellationToken, ) -> Result<()>

Start the background file watcher.

This is the second method call - should be called after new(). Spawns a background task that watches for file changes and refreshes the index.

§Arguments
  • cancel_token - Cancellation token for graceful shutdown
§Returns
  • Result<()> - Success or error
§Behavior
  • Spawns a detached background task
  • Watches for file modifications, deletions, and renames
  • Batches events to avoid overhead with rapid changes
  • Flushes batch when no new events for FSW_BATCH_FLUSH_MS
  • Logs all file system events and refresh operations
  • Continues running even if individual refresh operations fail
  • Stops gracefully when the cancellation token is cancelled

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> 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> 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
Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,