Struct FsIndex

pub struct FsIndex { /* private fields */ }

Index of a directory for cooklang recipes

The index contains all recipes in the directory.

Implementations

impl FsIndex

pub fn base_path(&self) -> &Utf8Path

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

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>

pub fn get_all(&self) -> impl Iterator<Item = RecipeEntry> + '_

pub fn remove(&mut self, path: &Utf8Path) -> Result<(), Error>

Remove a recipe from the index

The parameter is the path in disk and has to be prefixed with the base path.

Errors

The only possible is `Error::InvalidName``.

Panics

If the path does not start with the base path.

pub fn insert(&mut self, path: &Utf8Path) -> Result<(), Error>

Manually add a recipe to the index

This does not check if the path contains references to parent dirs and therefore a recipe outside the base directory can be refereced.

Errors

The only possible is `Error::InvalidName``.

Panics

• If the path does not start with the base path
• If the file does not exist.

Trait Implementations

impl Debug for FsIndex

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

Formats the value using the given formatter.