vault
a persistent store for values of arbitrary types
https://github.com/HeinrichApfelmus/vault
| Version on this page: | 0.3.1.5@rev:8 |
| LTS Haskell 23.2: | 0.3.1.5@rev:9 |
| Stackage Nightly 2025-01-02: | 0.3.1.5@rev:9 |
| Latest on Hackage: | 0.3.1.5@rev:9 |
vault-0.3.1.5@sha256:1bbfdd061747cee5f678b5ac21d2513fa7184524506a3ab42f58191972694b59,2473Module documentation for 0.3.1.5
- Data
- Data.Unique
- Data.Vault
Vault is a tiny library that provides a single data structure called vault.
A vault is a type-safe, persistent storage for values of arbitrary types. Like IORef, I want to be able to store values of any type in it, but unlike IORef, I want the storage space to behave like a persistent, first-class data structure, as appropriate for a purely functional language.
It is analogous to a bank vault, where you can access different bank boxes with different keys; hence the name.
In other words, a vault is an abstract data type with the following basic signature
data Key a
data Vault
newKey :: IO (Key a)
empty :: Vault
lookup :: Key a -> Vault -> Maybe a
insert :: Key a -> a -> Vault -> Vault
delete :: Key a -> Vault -> Vault
A few common functions for finite maps, like adjust and union, are provided as well.
This library was created thanks to the feedback on my blog post Vault - a persistent store for values of arbitrary types.
Installation
The whole thing is available on hackage, so you just have to type
cabal update
cabal install vault
Feedback
Use the issue tracker or send an email to the maintainer.