Skip to main content

IncrementalIndexer

Struct IncrementalIndexer 

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

Incremental indexer for processing file changes.

The IncrementalIndexer batches file system events and processes them on flush, avoiding full re-indexing of the codebase.

§Examples

use forgekit_core::indexing::IncrementalIndexer;
use forgekit_core::watcher::WatchEvent;
use std::path::PathBuf;

let indexer = IncrementalIndexer::new(store);

// Queue some changes (only src/ and tests/ files will be indexed)
indexer.queue(WatchEvent::Modified(PathBuf::from("src/lib.rs")));
indexer.queue(WatchEvent::Created(PathBuf::from("tests/test.rs")));
indexer.queue(WatchEvent::Modified(PathBuf::from("target/debug/build.rs"))); // Ignored

// Process changes
indexer.flush().await?;

Implementations§

Source§

impl IncrementalIndexer

Source

pub fn new(store: Arc<UnifiedGraphStore>) -> Self

Creates a new incremental indexer with default path filtering.

By default, only files in src/ and tests/ directories are indexed.

§Arguments
  • store - The graph store for index updates
Source

pub fn with_filter(store: Arc<UnifiedGraphStore>, filter: PathFilter) -> Self

Creates a new incremental indexer with a custom path filter.

§Arguments
  • store - The graph store for index updates
  • filter - Custom path filter
Source

pub fn filter(&self) -> &PathFilter

Returns a reference to the path filter.

Source

pub fn set_filter(&mut self, filter: PathFilter)

Sets a new path filter.

Source

pub fn queue(&self, event: WatchEvent)

Queues a watch event for processing.

Only files matching the path filter will be queued.

§Arguments
  • event - The watch event to queue
Source

pub async fn flush(&self) -> Result<FlushStats>

Flushes pending changes to the graph store.

This method processes all queued file changes and updates the index incrementally.

§Returns

Ok(()) if flush succeeded, or an error.

§Errors

Returns an error if any file cannot be indexed.

Source

pub async fn full_rescan(&self, root: &Path) -> Result<usize>

Performs a full rescan of the codebase.

This clears all pending changes and re-indexes from scratch, respecting the path filter.

§Arguments
  • root - The root directory to scan
§Returns

Ok(count) with number of files indexed, or an error.

Source

pub async fn pending_count(&self) -> usize

Returns the number of pending files to process.

Source

pub async fn clear_pending(&self)

Clears all pending changes without processing.

Trait Implementations§

Source§

impl Clone for IncrementalIndexer

Source§

fn clone(&self) -> IncrementalIndexer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IncrementalIndexer

Source§

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

Formats the value using the given formatter. 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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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