vault: a persistent store for values of arbitrary types

[ bsd3, data, library ] [ Propose Tags ]

A vault is a persistent store for values of arbitrary types. It's like having first-class access to the storage space behind IORefs.

The data structure is analogous to a bank vault, where you can access different bank boxes with different keys; hence the name.

Also provided is a locker type, representing a store for a single element.


[Skip to Readme]
Versions 0.1.0.0, 0.2.0.0, 0.2.0.1, 0.2.0.3, 0.2.0.4, 0.3.0.0, 0.3.0.1, 0.3.0.2, 0.3.0.3, 0.3.0.4, 0.3.0.5, 0.3.0.6, 0.3.0.7, 0.3.1.0
Dependencies base (>=4.4 && <5), containers (>=0.4 && <0.6), hashable (>=1.1 && <1.3), unordered-containers (>=0.2.1.0 && <0.3) [details]
License BSD-3-Clause
Copyright (c) Heinrich Apfelmus 2011
Author Heinrich Apfelmus, Elliott Hird
Maintainer Heinrich Apfelmus <apfelmus at quantentunnel de>
Revised Revision 1 made by HerbertValerioRiedel at Tue Oct 25 21:44:11 UTC 2016
Category Data
Home page https://github.com/HeinrichApfelmus/vault
Source repo head: git clone git://github.com/HeinrichApfelmus/vault.git
Uploaded by HeinrichApfelmus at Fri Dec 14 10:08:09 UTC 2012
Distributions Arch:0.3.1.0, Debian:0.3.0.5, Fedora:0.3.0.7, FreeBSD:0.3.0.4, LTSHaskell:0.3.1.0, NixOS:0.3.1.0, Stackage:0.3.1.0, openSUSE:0.3.1.0
Downloads 94967 total (253 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
useghc

Use GHC-specific packages and extensions.

EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for vault-0.2.0.3

[back to package description]

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.