Struct WorkspaceIndex 

pub struct WorkspaceIndex { /* private fields */ }

Implementations

impl WorkspaceIndex

pub fn load(settings: Settings) -> Result<Self, AgdError>

pub fn skipped_files(&self) -> impl Iterator<Item = (&Path, &str)>

Agenda files left out of the index, with the reason: non-UTF-8 content, or a symlink that resolves outside the roots.

pub fn roots(&self) -> &RootSet

pub fn settings(&self) -> &Settings

pub fn refresh_path(&mut self, path: &Path) -> Result<(), AgdError>

Re-reads one changed path, as a file watcher reports it. An agenda file, including one created after the index loaded, is parsed again; another .org file under the roots only updates the IDs that make targets ambiguous; a removed file or directory leaves the index; a symlink resolving outside the roots is skipped. Other paths are ignored.

pub fn documents(&self) -> impl Iterator<Item = &OrgDocument>

pub fn items(&self) -> impl Iterator<Item = &Item>

pub fn duplicate_ids(&self) -> impl Iterator<Item = (&str, &[(PathBuf, usize)])>

pub fn id_in_use(&self, id: &str) -> bool

Whether any heading under the roots, agenda file or not, has this :ID:.

pub fn document(&self, path: &Path) -> Option<&OrgDocument>

pub fn resolve( &self, item_ref: &str, ) -> Result<(&OrgDocument, &HeadlineSpan), AgdError>

Trait Implementations

impl Clone for WorkspaceIndex

fn clone(&self) -> Self

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.