ari-party/rojo
1
0
Fork 0
forked from rojo-rbx/rojo
Code Pull Requests Activity

Choose 'memofs' as the vfs name

Browse Source
This commit is contained in:
Lucien Greathouse
2020-03-10 17:57:57 -07:00
parent 477e0ada32
commit f61f3671a6
4 changed files with 49 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
vfs/README.md
View File

@@ -1,5 +1,18 @@
# [vfs]
Name pending. Implementation of a virtual filesystem with a configurable backend and file watching.
# vfs
Implementation of a virtual filesystem with a configurable backend and file watching.
memofs is currently an unstable minimum viable library. Its primary consumer is [Rojo](https://github.com/rojo-rbx/rojo), a build system for Roblox.
### Current Features
* API similar to `std::fs`
* Configurable backends
* `StdBackend`, which uses `std::fs` and the `notify` crate
* `NoopBackend`, which always throws errors
* `InMemoryFs`, a simple in-memory filesystem useful for testing
### Future Features
* Hash-based hierarchical memoization keys (hence the name)
* Configurable caching (write-through, write-around, write-back)
## License
[vfs] is available under the terms of the MIT license. See [LICENSE.txt](LICENSE.txt) or <https://opensource.org/licenses/MIT> for more details.
memofs is available under the terms of the MIT license. See [LICENSE.txt](LICENSE.txt) or <https://opensource.org/licenses/MIT> for more details.