transformfs

A read-only FUSE filesystem to transform the content of files with Lua.

In transformfs, the content of files can be transformed on demand by user-defined Lua scripts while preserving the same directory structure.

This filesystem is useful to transform data without duplicating the original files.

Installation

Cargo

cargo install transformfs

Usage

# mount transformfs
transformfs -s <lua_script> <src_dir> <mnt_point>

# umount
fusermount -u <mnt_point>

The Lua script must return a module with the following functions:

• open(filename): (optional) Called when opening a file if defined. Useful to open the file in advance for performance
• close(filename): (optional) Called when closing a file if defined. Useful to reclaim resources
• read_metadata(filename): Return the metadata of the file as a table. size can be set if a user wants to change the size.
• read_data(filename, offset, size): Return the content of the file as string at a specific position.

See example scripts in examples directory.

License

AGPL-3.0