IndexRegistry

Struct IndexRegistry 

Source
pub struct IndexRegistry<I: Index> { /* private fields */ }
Expand description

Generic registry for index entries.

Provides:

  • Named lookup with priority-based overrides
  • Lazy content loading with caching
  • Summary generation for system prompts

§Example

let registry = IndexRegistry::new();
registry.register(skill_index);

// Get metadata (always fast)
let idx = registry.get("commit").unwrap();

// Load full content (lazy, cached)
let content = registry.load_content("commit").await?;

// Generate summary for system prompt
let summary = registry.build_summary();

Implementations§

Source§

impl<I: Index> IndexRegistry<I>

Source

pub fn new() -> Self

Create a new empty registry.

Source

pub fn register(&mut self, index: I)

Register an index entry.

If an entry with the same name exists, it’s replaced only if the new entry has equal or higher priority.

Source

pub fn register_all(&mut self, indices: impl IntoIterator<Item = I>)

Register multiple index entries.

Source

pub fn get(&self, name: &str) -> Option<&I>

Get an index entry by name.

Source

pub fn list(&self) -> Vec<&str>

List all registered names.

Source

pub fn iter(&self) -> impl Iterator<Item = &I>

Iterate over all index entries.

Source

pub fn len(&self) -> usize

Get the number of registered entries.

Source

pub fn is_empty(&self) -> bool

Check if the registry is empty.

Source

pub fn contains(&self, name: &str) -> bool

Check if an entry with the given name exists.

Source

pub async fn remove(&mut self, name: &str) -> Option<I>

Remove an entry by name.

Also clears the cached content for this entry.

Source

pub async fn clear(&mut self)

Clear all entries.

Also clears all cached content.

Source

pub async fn load_content(&self, name: &str) -> Result<String>

Load content for an index entry with caching.

Returns cached content if available, otherwise loads from source.

Source

pub async fn invalidate_cache(&self, name: &str)

Invalidate cached content for an entry.

Source

pub async fn clear_cache(&self)

Clear all cached content.

Source

pub fn build_summary(&self) -> String

Build a summary of all entries for system prompt injection.

Returns a formatted string with one summary line per entry.

Source

pub fn build_summary_with<F>(&self, formatter: F) -> String
where F: Fn(&I) -> String,

Build a summary with a custom formatter.

Source

pub fn sorted_by_priority(&self) -> Vec<&I>

Get entries sorted by priority (highest first).

Source

pub fn filter<F>(&self, predicate: F) -> Vec<&I>
where F: Fn(&I) -> bool,

Filter entries by a predicate.

Source§

impl<I: Index + PathMatched> IndexRegistry<I>

Source

pub fn find_matching(&self, path: &Path) -> Vec<&I>

Find all entries that match the given file path.

Returns entries sorted by priority (highest first).

§Example
let matching = registry.find_matching(Path::new("src/lib.rs"));
for entry in matching {
    println!("Matched: {}", entry.name());
}
Source

pub async fn load_matching(&self, path: &Path) -> Vec<LoadedEntry<I>>

Load content for all entries matching the given file path.

Returns loaded entries sorted by priority (highest first). Entries that fail to load are skipped.

Source

pub fn has_matching(&self, path: &Path) -> bool

Check if any entry matches the given file path.

Source

pub fn build_matching_summary(&self, path: &Path) -> String

Build summary for entries matching a specific path.

Source§

impl IndexRegistry<OutputStyle>

Source

pub fn with_builtins() -> Self

Available on crate feature cli-integration only.
Source

pub async fn load_from_directories( &mut self, working_dir: Option<&Path>, ) -> Result<()>

Available on crate feature cli-integration only.

Trait Implementations§

Source§

impl<I: Index> Clone for IndexRegistry<I>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I: Index> Default for IndexRegistry<I>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<I: Index> FromIterator<I> for IndexRegistry<I>

Source§

fn from_iter<T: IntoIterator<Item = I>>(iter: T) -> Self

Creates a value from an iterator. Read more

Auto Trait Implementations§

§

impl<I> Freeze for IndexRegistry<I>

§

impl<I> !RefUnwindSafe for IndexRegistry<I>

§

impl<I> Send for IndexRegistry<I>

§

impl<I> Sync for IndexRegistry<I>

§

impl<I> Unpin for IndexRegistry<I>
where I: Unpin,

§

impl<I> !UnwindSafe for IndexRegistry<I>

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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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> 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