https://github.com/srid/unionmount

Union mount in Haskell, with fsnotify
https://github.com/srid/unionmount

filesystem haskell unionfs

Last synced: 2 months ago
JSON representation

Union mount in Haskell, with fsnotify

• Host: GitHub
• URL: https://github.com/srid/unionmount
• Owner: srid
• License: mit
• Created: 2021-11-21T22:29:02.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T15:01:26.000Z (10 months ago)
• Last Synced: 2024-10-11T23:49:38.507Z (3 months ago)
• Topics: filesystem, haskell, unionfs
• Language: Haskell
• Homepage:
• Size: 57.6 KB
• Stars: 12
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# unionmount

Haskell library to "[union mount](https://en.wikipedia.org/wiki/Union_mount)" a bunch of folders onto an in-memory data structure, and keeping the latter in sync as the files change over time. Used in [Ema](https://ema.srid.ca) and [Emanote](https://emanote.srid.ca).

## Usage

Both the `mount` and `unionMount` functions return a tuple value of type [Dynamic](https://ema.srid.ca/guide/model/dynamic), giving direct access to the initial value as well as the updater function that may be run in a separate thread. See [how Ema uses it](https://github.com/EmaApps/ema/blob/459d3899e0b9ea13e23c81126279dc62530b994c/src/Ema/App.hs#L72-L84) for an illustration.

### Examples

See [this example](https://github.com/EmaApps/ema/blob/459d3899e0b9ea13e23c81126279dc62530b994c/src/Ema/Route/Lib/Extra/PandocRoute.hs#L132-L139) illustrating mounting a directory of Markdown files into (effectively) a `Map FilePath String`. A [more involved example](https://github.com/EmaApps/emanote/blob/7c49c73cd3b7dbeace72353574f3decfb68929f2/src/Emanote/Source/Dynamic.hs#L58-L64) from Emanote demonstrates the "union" aspect of the library.