5 releases (3 breaking)
0.4.0 | Aug 15, 2024 |
---|---|
0.3.0 | Jul 9, 2024 |
0.2.0 | Jun 26, 2024 |
0.1.1 | Jun 26, 2024 |
0.1.0 | Jun 24, 2024 |
#158 in Filesystem
143 downloads per month
27KB
550 lines
transformfs
A read-only FUSE filesystem to transform input files to output files with Lua script.
In transformfs, the input files can be transformed on demand by the user-defined Lua script. The inputs are a list of files passed to the user script, and the user script returns a list of files to generate dynamically.
This filesystem is useful to transform data without duplicating or modifying the original files.
Installation
Cargo
cargo install transformfs
Nix
Transformfs is also packaged as an NUR package nur.repos.dcsunset.transformfs
.
You can install it by including it in your nix config.
Usage
# mount transformfs
transformfs -s <lua_script> [-i <input1>...] <mnt_point>
# umount
fusermount -u <mnt_point>
The inputs can be zero, one, or multiple files or directories (directories are resolved to individual files).
The user Lua script must return a module (table) with the following functions as its fields:
transform(inputs)
: Function to transform inputs (a list of file paths) to outputs. It should return a list ofOutput
.
Each Output
is table with the following fields:
path
: Path of the filemetadata
: Return the metadata of the file asFileMetadata
.open()
: (optional) Called when opening a file if defined. Useful to open the file in advance for performanceclose()
: (optional) Called when closing a file if defined. Useful to reclaim resourcesread(offset, size)
: Return the content of the file as string at a specific position.
FileMetadata
fields:
size
: Size of the fileblock_size
: (optional) Block size of the file (default: 512)
Transformfs uses LuaJIT for performance reason as Lua code is executed very frequently for large files. Thus it may not support new features in Lua 5.3 or 5.4 at the time of writing.
See example scripts in examples
directory for more details and transformfs --help
.
License
AGPL-3.0
Dependencies
~6–16MB
~207K SLoC