Struct RootSet 

pub struct RootSet { /* private fields */ }

Implementations

impl RootSet

pub fn new(roots: &[String], agenda: &[String]) -> Result<Self, AgdError>

roots are the only directories agd may read or write; agenda holds the agenda file patterns (files, directories or globs).

pub fn roots(&self) -> &[PathBuf]

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

pub fn is_agenda_file(&self, canonical: &Path) -> Result<bool, AgdError>

Whether discovery would list this canonical .org path as an agenda file: an exact absolute entry, or a pattern matching it relative to its root outside hidden directories (which the walk skips). Lets a file created after the index loaded join it.

pub fn resolve_read(&self, requested: &Path) -> Result<PathBuf, AgdError>

pub fn resolve_write( &self, requested: &Path, create: bool, ) -> Result<PathBuf, AgdError>

pub fn agenda_files(&self) -> Result<OrgFiles, AgdError>

The agenda files: every .org file under the roots that matches an agenda pattern.

pub fn all_org_files(&self) -> Result<OrgFiles, AgdError>

Every .org file under the roots, agenda file or not.

Trait Implementations

impl Clone for RootSet

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 RootSet

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

Formats the value using the given formatter.