Crate cooklang_fs

Source
Expand description

cooklang-rs helper crate for the file system.

Utilities to deal with referencing recipe, images and data related to recipes that are in other files.

It implements an index into the file system to efficiently resolve recipes from a path. The index can be lazy or eager. Both created with new_index.

Structs§

DirEntry
FsIndex
Index of a directory for cooklang recipes
FsIndexBuilder
Image
ImageIndexes
LazyFsIndex
Lazy index of a directory for cooklang recipes
NonUtf8
NotRecipe
RecipeContent
RecipeEntry

Enums§

Entry
Error
RecipeImageError

Constants§

IMAGE_EXTENSIONS
Valid image extensions

Functions§

all_recipes
Get all recipes from a path with a depth limit
check_recipe_images
Check that all images for a recipe actually can reference it.
new_index
recipe_images
Get a list of the images of the recipe
walk_dir
Walks a single directory retrieving recipes and other directories