vault

a persistent store for values of arbitrary types

https://github.com/HeinrichApfelmus/vault

Version on this page:	0.3.0.5
LTS Haskell 23.23:	0.3.1.5@rev:10
Stackage Nightly 2025-05-23:	0.3.1.5@rev:10
Latest on Hackage:	0.3.1.5@rev:10

See all snapshots vault appears in

BSD-3-Clause licensed by Heinrich Apfelmus, Elliott Hird

Maintained by Heinrich Apfelmus <apfelmus at quantentunnel de>

This version can be pinned in stack with:vault-0.3.0.5@sha256:27f58f2dc21543b9376d62d78fdeb0679f093025395989df81b90453a24ecebf,1862

Module documentation for 0.3.0.5

Data
- Data.Unique
  - Data.Unique.Really
- Data.Vault
  - Data.Vault.Lazy
  - Data.Vault.ST
    - Data.Vault.ST.Lazy
    - Data.Vault.ST.Strict
  - Data.Vault.Strict

Depends on 4 packages(full list with versions):

base, containers, hashable, unordered-containers

Used by 11 packages in lts-4.0(full list with versions):

apiary, apiary-clientsession, serversession-frontend-wai, Spock, wai, wai-extra, wai-middleware-crowd, wai-predicates, wai-routes, wai-session, warp

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.

Changes

Changelog for the `vault` package

0.3.0.5

Add support for GHC type roles extension, using the RoleAnnotations language pragma.

0.3.0.4 — Bump upper version bound for the base dependency.

0.3.0.3 — Bump upper version bound for the base dependency.

0.3.0.2 — Fix tarball.

0.3.0.1 — Use CPP to reduce code duplication.

0.3.0.0

Split modules into Lazy and Strict variants, no default choice.
Add Hashable instance to Data.Unique.Really for all implementations.