Data.FixFile.Trie

This is a Trie data type that can be used with FixFile. It can be used as a key-value store where the key is a ByteString of arbitrary size.

Documentation

data Trie v a

Fixed (Trie v) is a trie mapping lazy ByteStrings to values of type v.

Instances

Functor (Trie v)

Foldable (Trie v)

Traversable (Trie v)

(Read v, Read a) => Read (Trie v a)

(Show v, Show a) => Show (Trie v a)

Generic (Trie v a)

(Binary v, Binary a) => Binary (Trie v a)

type Rep (Trie v a)

empty :: Fixed g => g (Trie v)

An empty Trie

freeze :: Fixed g => g (Trie v) -> g (Trie v)

freeze takes a Trie that has been mutated and creates a copy of it that allows for faster lookups. This happens automatically for Tries that are serialized to a FixFile. A Trie will be automatically thawed on any node that is modified.

createTrieFile :: (Binary v, Typeable v) => FilePath -> IO (FixFile (Ref (Trie v)))

Create a FixFile of (Trie v) data.

openTrieFile :: (Binary v, Typeable v) => FilePath -> IO (FixFile (Ref (Trie v)))

Open a FixFile of (Trie v) data.

lookupTrie :: Fixed g => ByteString -> g (Trie v) -> Maybe v

Lookup a possible value stored in a trie for a given ByteString key.

lookupTrieT :: Binary v => ByteString -> Transaction (Ref (Trie v)) s (Maybe v)

Transaction version of lookupTrie.

insertTrie :: Fixed g => ByteString -> v -> g (Trie v) -> g (Trie v)

Insert a value into a trie for the given ByteString key.

insertTrieT :: Binary v => ByteString -> v -> Transaction (Ref (Trie v)) s ()

Transaction version of insertTrie.

deleteTrie :: Fixed g => ByteString -> g (Trie v) -> g (Trie v)

Delete a value from a trie for a given ByteString key.

deleteTrieT :: Binary v => ByteString -> Transaction (Ref (Trie v)) s ()

Transaction version of deleteTrie.

iterateTrie :: Fixed g => ByteString -> g (Trie v) -> [(ByteString, v)]

Iterate over a Trie for all of the ByteString and value tuples for a given ByteString prefix.

iterateTrieT :: Binary v => ByteString -> Transaction (Ref (Trie v)) s [(ByteString, v)]

Transaction version of iterateTrie.

trieMap :: (Fixed h, Fixed i) => (v -> v') -> h (Trie v) -> i (Trie v')

Map a function over a Fixed Trie. Because of the data types used, this can't be implemented as a Functor.