Struct LazyFsIndex

pub struct LazyFsIndex { /* private fields */ }

Lazy index of a directory for cooklang recipes

The index is lazy, so it will only search for things it needs when asked, not when created. Also, it tries to walk the least amount possible in the given directory.

Calling the methods on this structure when it’s shared between threads can panic. To avoid this issue put it behind a Mutex (not RwLock) or use FsIndex by calling Self::index_all or creating a new one.

Implementations

impl LazyFsIndex

pub fn base_path(&self) -> &Utf8Path

pub fn contains(&self, recipe: &str) -> bool

Check if the index contains a recipe

pub fn index_all(self) -> Result<FsIndex, Error>

Completes the lazy indexing returning a complete FsIndex

pub fn resolve( &self, recipe: &str, relative_to: Option<&Utf8Path>, ) -> Result<RecipeEntry, Error>

Resolves a recipe query first trying directly as a path and if it fails performs a lookup in the index.

The recipe cannot be outside the base path.

pub fn get(&self, recipe: &str) -> Result<RecipeEntry, Error>

Get a recipe from the index

The input recipe is a partial path with or without the .cook extension.

Trait Implementations

impl Debug for LazyFsIndex

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

Formats the value using the given formatter.