Struct WorkspaceIndex 

pub struct WorkspaceIndex { /* private fields */ }

Workspace-wide index for cross-file analysis

Contains pre-extracted information from all markdown files in the workspace, enabling rules to validate cross-file references efficiently.

Implementations

impl WorkspaceIndex

pub fn new() -> Self

Create a new empty workspace index

pub fn version(&self) -> u64

Get the current version (for cache invalidation)

pub fn file_count(&self) -> usize

Get the number of indexed files

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

Check if a file is in the index

pub fn get_file(&self, path: &Path) -> Option<&FileIndex>

Get the index data for a specific file

pub fn insert_file(&mut self, path: PathBuf, index: FileIndex)

Insert or update a file’s index data

pub fn remove_file(&mut self, path: &Path) -> Option<FileIndex>

Remove a file from the index

pub fn get_vulnerable_anchors(&self) -> HashMap<String, Vec<VulnerableAnchor>>

Build a map of all “vulnerable” anchors across the workspace

A vulnerable anchor is an auto-generated anchor for a heading that does NOT have a custom anchor defined. These are problematic for translated content because the anchor changes when the heading is translated.

Returns: Map from lowercase anchor → Vec of VulnerableAnchor info Multiple files can have headings with the same auto-generated anchor, so we collect all occurrences.

pub fn all_headings(&self) -> impl Iterator<Item = (&Path, &HeadingIndex)>

Get all headings across the workspace (for debugging/testing)

pub fn files(&self) -> impl Iterator<Item = (&Path, &FileIndex)>

Iterate over all files in the index

pub fn clear(&mut self)

Clear the entire index

pub fn update_file(&mut self, path: &Path, index: FileIndex)

Update a file’s index and maintain reverse dependencies

This method:

1. Removes this file as a source (dependent) from all reverse deps
2. Inserts the new file index
3. Builds new reverse deps from cross_file_links

pub fn get_dependents(&self, path: &Path) -> Vec<PathBuf>

Get files that depend on (link to) the given file

Returns a list of file paths that contain links targeting this file. Used to re-lint dependent files when a target file changes.

pub fn is_file_stale(&self, path: &Path, current_hash: &str) -> bool

Check if a file needs re-indexing based on its content hash

Returns true if the file is not in the index or has a different hash.

pub fn retain_only(&mut self, current_files: &HashSet<PathBuf>) -> usize

Retain only files that exist in the given set, removing deleted files

This prunes stale entries from the cache for files that no longer exist. Returns the number of files removed.

pub fn save_to_cache(&self, cache_dir: &Path) -> Result<()>

Save the workspace index to a cache file

Uses postcard for efficient binary serialization with:

• Magic header for file type validation
• Format version for compatibility detection
• Atomic writes (temp file + rename) to prevent corruption

pub fn load_from_cache(cache_dir: &Path) -> Option<Self>

Load the workspace index from a cache file

Returns None if:

• Cache file doesn’t exist
• Magic header doesn’t match
• Format version is incompatible
• Data is corrupted

Trait Implementations

impl Clone for WorkspaceIndex

fn clone(&self) -> WorkspaceIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceIndex

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

Formats the value using the given formatter.

impl Default for WorkspaceIndex

fn default() -> WorkspaceIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkspaceIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkspaceIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.