Struct RuleIndex 

pub struct RuleIndex {
    pub name: String,
    pub description: String,
    pub paths: Option<Vec<String>>,
    pub priority: i32,
    pub source: ContentSource,
    pub source_type: SourceType,
    /* private fields */
}

Rule index entry - minimal metadata for progressive disclosure.

Contains only metadata needed for system prompt injection. Full rule content is loaded on-demand via load_content().

Fields

name: String

Rule name (unique identifier).

description: String

Human-readable description of what this rule does.

paths: Option<Vec<String>>

Path patterns this rule applies to (glob syntax). None means this is a global rule that applies to all files.

priority: i32

Explicit priority for ordering. Higher values take precedence. This is separate from source_type-based priority in the Index trait.

source: ContentSource

Content source for lazy loading.

source_type: SourceType

Source type (builtin, user, project).

Implementations

impl RuleIndex

pub fn new(name: impl Into<String>) -> Self

Create a new rule index entry.

Uses ContentSource::default() (empty InMemory) as placeholder. Call with_source() to set the actual content source.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the rule description.

pub fn with_paths(self, paths: Vec<String>) -> Self

Set path patterns this rule applies to.

pub fn with_priority(self, priority: i32) -> Self

Set the explicit priority.

pub fn with_source(self, source: ContentSource) -> Self

Set the content source.

pub fn with_source_type(self, source_type: SourceType) -> Self

Set the source type.

pub fn from_file(path: &Path) -> Option<Self>

Load rule from a file path.

pub fn parse_with_frontmatter(content: &str, path: &Path) -> Option<Self>

Parse rule from content with frontmatter.

Uses the generic parse_frontmatter<RuleFrontmatter>() parser. Falls back to defaults if frontmatter is missing or invalid.

Trait Implementations

impl Clone for RuleIndex

fn clone(&self) -> RuleIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index for RuleIndex

fn priority(&self) -> i32

Override priority to use explicit field instead of source_type-based.

Rules need explicit ordering independent of their source type.

fn source(&self) -> &ContentSource

Get the content source for lazy loading.

fn source_type(&self) -> SourceType

Get the source type (builtin, user, project, managed).

fn to_summary_line(&self) -> String

Generate a summary line for context injection.

fn description(&self) -> &str

Get a short description for this index entry.

fn load_content<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Load the full content from the source.

impl Named for RuleIndex

fn name(&self) -> &str

impl PathMatched for RuleIndex

fn path_patterns(&self) -> Option<&[String]>

Get the path patterns this entry matches.

fn matches_path(&self, file_path: &Path) -> bool

Check if this entry matches the given file path.

fn is_global(&self) -> bool

Check if this is a global entry (matches all files).

impl Serialize for RuleIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.