Struct BrainIndex 

pub struct BrainIndex { /* private fields */ }

Implementations

impl BrainIndex

pub fn open(brain_path: impl AsRef<Path>) -> Result<Self>

pub fn rebuild(&self) -> Result<usize>

Walk the brain directory, parse markdown files, and repopulate the index.

Reading and parsing every file is embarrassingly parallel and is the dominant cost for large vaults, so it runs across a rayon thread pool. The results are then funneled through a single writer that performs all inserts inside one transaction (rather than one implicit transaction/fsync per file), which is what actually matters for indexing thousands of files quickly on real disks.

Returns the number of files indexed.

pub fn query( &self, text: &str, filters: QueryFilters, ) -> Result<Vec<BrainEntry>>

Full-text search with optional filters.

pub fn get(&self, id: &str) -> Result<Option<BrainEntry>>

Fetch a single entry by its relative path id.

pub fn backlinks(&self, id: &str) -> Result<Vec<BrainEntry>>

Entries whose links resolve to id (i.e. entries that link to id).

Resolution rule (matches the app’s render-time wikilink resolution): a raw link target t resolves to entry e when t == e.name OR t == e.id OR stem(t) == stem(e.id) OR stem(t) == e.name.

pub fn outlinks(&self, id: &str) -> Result<Vec<BrainEntry>>

Resolved targets of id’s own links (i.e. entries that id links to).

pub fn links_all(&self) -> Result<Vec<(String, String)>>

The full resolved (from_id, to_id) edge list, for pinboard rendering.

pub fn related(&self, id: &str, limit: usize) -> Result<Vec<BrainEntry>>

Entries related to id, ranked: direct links (either direction) first, then co-citation (entries reachable via a shared linked target or a shared linking source), then entries sharing at least one tag. Deduplicated, excludes id itself, capped at limit.