https://github.com/heinrichapfelmus/vault

A typed, persistent store for values of arbitrary types
https://github.com/heinrichapfelmus/vault

haskell immutable-datastructures type-safety

Last synced: about 1 year ago
JSON representation

A typed, persistent store for values of arbitrary types

• Host: GitHub
• URL: https://github.com/heinrichapfelmus/vault
• Owner: HeinrichApfelmus
• License: bsd-3-clause
• Created: 2011-09-07T12:21:59.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2025-03-09T11:36:19.000Z (about 1 year ago)
• Last Synced: 2025-04-11T12:37:15.325Z (about 1 year ago)
• Topics: haskell, immutable-datastructures, type-safety
• Language: C
• Homepage:
• Size: 98.6 KB
• Stars: 60
• Watchers: 6
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/HeinrichApfelmus/vault.png)](https://travis-ci.org/HeinrichApfelmus/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][1].

  [1]: http://apfelmus.nfshost.com/blog/2011/09/04-vault.html

Installation

============

The whole thing is [available on hackage][hackage], so you just have to type

    cabal update

    cabal install vault

  [hackage]: http://hackage.haskell.org/package/vault

Feedback

========

Use the [issue tracker][2] or send an [email to the maintainer][3].

  [2]: https://github.com/HeinrichApfelmus/vault/issues

  [3]: mailto:apfelmus@quantentunnel.de