Struct TitleIndex 

pub struct TitleIndex { /* private fields */ }

A name → document(s) index built by scanning a workspace. Names are the documents’ title fields and their file stems; a document is registered under both so [[My File]] (by title) and [[my-file]] (by stem) both find it.

Implementations

impl TitleIndex

pub fn new() -> Self

An empty index.

pub fn insert(&mut self, name: impl Into<String>, path: impl Into<PathBuf>)

Index path under name (a title or a file stem). A blank name is ignored; a duplicate (name, path) pair collapses, so registering a document under both a title and an identical stem does not make it look ambiguous.

pub fn resolve(&self, name: &str) -> TitleMatch

Resolve name to a document. Unique when exactly one claims it, Ambiguous when several do, Unknown when none.

pub fn is_empty(&self) -> bool

Whether the index knows no names.

pub fn len(&self) -> usize

The number of distinct names known.

Trait Implementations

impl Clone for TitleIndex

fn clone(&self) -> TitleIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TitleIndex

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

Formats the value using the given formatter.

impl Default for TitleIndex

fn default() -> TitleIndex

Returns the “default value” for a type.