Struct FileIndex 

pub struct FileIndex {
    pub headings: Vec<HeadingIndex>,
    pub reference_links: Vec<ReferenceLinkIndex>,
    pub cross_file_links: Vec<CrossFileLinkIndex>,
    pub defined_references: HashSet<String>,
    pub content_hash: String,
    pub file_disabled_rules: HashSet<String>,
    pub persistent_transitions: Vec<(usize, HashSet<String>, HashSet<String>)>,
    pub line_disabled_rules: HashMap<usize, HashSet<String>>,
    /* private fields */
}

Index data extracted from a single file

Fields

headings: Vec<HeadingIndex>

Headings in this file with their anchors

reference_links: Vec<ReferenceLinkIndex>

Reference links in this file (for cross-file analysis)

cross_file_links: Vec<CrossFileLinkIndex>

Cross-file links in this file (for MD051 cross-file validation)

defined_references: HashSet<String>

Defined reference IDs (e.g., from [ref]: url definitions) Used to filter out reference links that have explicit definitions

content_hash: String

Content hash for change detection

file_disabled_rules: HashSet<String>

Rules disabled for the entire file (from inline comments) Used by cross-file rules to respect inline disable directives

persistent_transitions: Vec<(usize, HashSet<String>, HashSet<String>)>

Persistent disable/enable state transitions, sorted by line number. Each entry: (line, disabled_rules, enabled_rules). Use binary search to query.

line_disabled_rules: HashMap<usize, HashSet<String>>

Rules disabled at specific lines via disable-line / disable-next-line

Implementations

impl FileIndex

pub fn new() -> Self

Create a new empty file index

pub fn with_hash(content_hash: String) -> Self

Create a file index with the given content hash

pub fn add_heading(&mut self, heading: HeadingIndex)

Add a heading to the index

Also updates the anchor lookup map for O(1) anchor queries

pub fn add_anchor_alias(&mut self, anchor: String, heading_index: usize)

Add an alternative anchor that resolves to an existing heading. Used for platform-specific anchor conventions (e.g., Python-Markdown _N dedup).

pub fn has_anchor(&self, anchor: &str) -> bool

Check if an anchor exists in this file (O(1) lookup)

Returns true if the anchor matches any of:

• Auto-generated heading anchors
• Custom heading anchors (from {#id} syntax on headings)
• HTML anchors (from <a id="..."> or <element id="...">)
• Attribute anchors (from { #id } syntax on non-heading elements)

Matching is case-insensitive. URL-encoded anchors (e.g., CJK characters like %E6%97%A5%E6%9C%AC%E8%AA%9E for 日本語) are decoded before matching.

pub fn add_html_anchor(&mut self, anchor: String)

Add an HTML anchor (from <a id="..."> or <element id="..."> tags)

pub fn add_attribute_anchor(&mut self, anchor: String)

Add an attribute anchor (from { #id } syntax on non-heading elements)

pub fn get_heading_by_anchor(&self, anchor: &str) -> Option<&HeadingIndex>

Get the heading index for an anchor (O(1) lookup)

Returns the index into self.headings if found.

pub fn add_reference_link(&mut self, link: ReferenceLinkIndex)

Add a reference link to the index

pub fn is_rule_disabled_at_line(&self, rule_name: &str, line: usize) -> bool

Check if a rule is disabled at a specific line

Used by cross-file rules to respect inline disable directives. Checks both file-wide disables and line-specific disables.

pub fn add_cross_file_link(&mut self, link: CrossFileLinkIndex)

Add a cross-file link to the index (deduplicates by target_path, fragment, line)

pub fn add_defined_reference(&mut self, ref_id: String)

Add a defined reference ID (e.g., from [ref]: url)

pub fn has_defined_reference(&self, ref_id: &str) -> bool

Check if a reference ID has an explicit definition

pub fn hash_matches(&self, hash: &str) -> bool

Check if the content hash matches

pub fn heading_count(&self) -> usize

Get the number of headings

pub fn reference_link_count(&self) -> usize

Get the number of reference links

Trait Implementations

impl Clone for FileIndex

fn clone(&self) -> FileIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileIndex

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

Formats the value using the given formatter.

impl Default for FileIndex

fn default() -> FileIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.