Struct Paths 

pub struct Paths {
    pub root: PathBuf,
    pub base: PathBuf,
}

Filesystem layout for a single indexed project.

Fields

root: PathBuf

Project root (the directory being indexed).

base: PathBuf

The .greplm directory.

Implementations

impl Paths

pub fn new(root: impl AsRef<Path>) -> Self

pub fn segments_dir(&self) -> PathBuf

Directory holding immutable index segments.

pub fn config_file(&self) -> PathBuf

pub fn meta_file(&self) -> PathBuf

pub fn cache_file(&self) -> PathBuf

pub fn savings_file(&self) -> PathBuf

Append-only log of per-query token-savings records.

pub fn gitignore_file(&self) -> PathBuf

pub fn fst_file(&self, seg: u64) -> PathBuf

pub fn post_file(&self, seg: u64) -> PathBuf

pub fn docs_file(&self, seg: u64) -> PathBuf

pub fn syms_file(&self, seg: u64) -> PathBuf

pub fn refs_file(&self, seg: u64) -> PathBuf

pub fn live_file(&self, seg: u64) -> PathBuf

pub fn exists(&self) -> bool

True if an index directory exists.

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Paths

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

Formats the value using the given formatter.