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)

Methods

fmap :: (a -> b) -> Trie v a -> Trie v b

(<$) :: a -> Trie v b -> Trie v a

Foldable (Trie v)

Methods

fold :: Monoid m => Trie v m -> m

foldMap :: Monoid m => (a -> m) -> Trie v a -> m

foldr :: (a -> b -> b) -> b -> Trie v a -> b

foldr' :: (a -> b -> b) -> b -> Trie v a -> b

foldl :: (b -> a -> b) -> b -> Trie v a -> b

foldl' :: (b -> a -> b) -> b -> Trie v a -> b

foldr1 :: (a -> a -> a) -> Trie v a -> a

foldl1 :: (a -> a -> a) -> Trie v a -> a

toList :: Trie v a -> [a]

null :: Trie v a -> Bool

length :: Trie v a -> Int

elem :: Eq a => a -> Trie v a -> Bool

maximum :: Ord a => Trie v a -> a

minimum :: Ord a => Trie v a -> a

sum :: Num a => Trie v a -> a

product :: Num a => Trie v a -> a

Traversable (Trie v)

Methods

traverse :: Applicative f => (a -> f b) -> Trie v a -> f (Trie v b)

sequenceA :: Applicative f => Trie v (f a) -> f (Trie v a)

mapM :: Monad m => (a -> m b) -> Trie v a -> m (Trie v b)

sequence :: Monad m => Trie v (m a) -> m (Trie v a)

FixedTraversable (Trie v)

Methods

traverseF :: (Fixed g, Fixed g', Applicative h, (* ~ a) (Alg (Trie v))) => (a -> h b) -> g (Trie v) -> h (g' (Sub (Trie v) a b))

FixedFoldable (Trie v)

Methods

foldMapF :: (Fixed g, Monoid m, (* ~ a) (Alg (Trie v))) => (a -> m) -> g (Trie v) -> m

FixedFunctor (Trie v)

Methods

fmapF :: (Fixed g, Fixed g', (* ~ a) (Alg (Trie v))) => (a -> b) -> g (Trie v) -> g' (Sub (Trie v) a b)

FixedSub (Trie v)

Associated Types

type Sub (Trie v :: * -> *) v v' :: * -> *

FixedAlg (Trie v)

Associated Types

type Alg (Trie v :: * -> *) :: *

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

Methods

readsPrec :: Int -> ReadS (Trie v a)

readList :: ReadS [Trie v a]

readPrec :: ReadPrec (Trie v a)

readListPrec :: ReadPrec [Trie v a]

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

Methods

showsPrec :: Int -> Trie v a -> ShowS

show :: Trie v a -> String

showList :: [Trie v a] -> ShowS

Generic (Trie v a)

Associated Types

type Rep (Trie v a) :: * -> *

Methods

from :: Trie v a -> Rep (Trie v a) x

to :: Rep (Trie v a) x -> Trie v a

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

Methods

put :: Trie v a -> Put

get :: Get (Trie v a)

putList :: [Trie v a] -> Put

type Alg (Trie v)

type Alg (Trie v) = v

type Sub (Trie v) v v'

type Sub (Trie v) v v' = Trie v'

type Rep (Trie v a)

type Rep (Trie v a) = D1 (MetaData "Trie" "Data.FixFile.Trie" "fixfile-0.5.0.0-1jTlli8mcAjCEnKk18M3BS" False) ((:+:) ((:+:) (C1 (MetaCons "Value" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 v))) ((:+:) (C1 (MetaCons "Tail" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a)))) (C1 (MetaCons "String" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))))) ((:+:) (C1 (MetaCons "Small" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Word8, a)])))) ((:+:) (C1 (MetaCons "Big" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Array Word8 (Maybe a)))))) (C1 (MetaCons "Mutable" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Word8 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.