Copyright	2018 DFINITY Stiftung
License	GPL-3
Maintainer	Enzo Haussecker <enzo@dfinity.org>
Stability	Stable
Safe Haskell	None
Language	Haskell2010

Network.DFINITY.RadixTree

Contents

Class
Types
Create
Insert
Delete
Merkleize
Query
Test
Stream
Debug

Description

A generic data integrity layer.

Synopsis

class Monad m => RadixDatabase config m database | database -> config where
data RadixError
- = InvalidArgument String
- | StateRootDoesNotExist RadixRoot
type RadixRoot = ShortByteString
data RadixTree database
createRadixTree :: RadixDatabase config m database => Int -> Int -> Maybe RadixRoot -> config -> m (RadixTree database)
subtreeRadixTree :: RadixDatabase config m database => RadixRoot -> RadixTree database -> m (RadixTree database)
insertRadixTree :: RadixDatabase config m database => ByteString -> ByteString -> RadixTree database -> m (RadixTree database)
deleteRadixTree :: RadixDatabase config m database => ByteString -> RadixTree database -> m (RadixTree database)
merkleizeRadixTree :: RadixDatabase config m database => RadixTree database -> m (RadixRoot, RadixTree database)
lookupRadixTree :: RadixDatabase config m database => ByteString -> RadixTree database -> m (Maybe (ByteString, RadixTree database))
lookupMerkleizedRadixTree :: RadixDatabase config m database => ByteString -> RadixTree database -> m (Maybe (ByteString, RadixTree database))
lookupNonMerkleizedRadixTree :: RadixDatabase config m database => ByteString -> RadixTree database -> m (Maybe (ByteString, RadixTree database))
isEmptyRadixTree :: RadixTree database -> Bool
isValidRadixRoot :: RadixDatabase config m database => RadixRoot -> RadixTree database -> m Bool
sourceMerkleizedRadixTree :: MonadResource m => RadixDatabase config (ConduitM () ByteString m) database => [Bool] -> Int -> BoundedChan RadixRoot -> RadixTree database -> ConduitM () ByteString m ()
sinkMerkleizedRadixTree :: MonadResource m => RadixDatabase config (ConduitM ByteString () m) database => RadixRoot -> BoundedChan RadixRoot -> RadixTree database -> ConduitM ByteString () m (Either [RadixRoot] (RadixTree database))
contentsRadixTree :: RadixDatabase config m database => RadixTree database -> m [(ByteString, ByteString)]
contentsMerkleizedRadixTree :: RadixDatabase config m database => RadixTree database -> m [(ByteString, ByteString)]
contentsNonMerkleizedRadixTree :: RadixDatabase config m database => RadixTree database -> m [(ByteString, ByteString)]
printRadixTree :: MonadIO m => RadixDatabase config m database => RadixTree database -> m ()
printMerkleizedRadixTree :: MonadIO m => RadixDatabase config m database => RadixTree database -> m ()
printNonMerkleizedRadixTree :: MonadIO m => RadixDatabase config m database => RadixTree database -> m ()

Class

class Monad m => RadixDatabase config m database | database -> config where Source #

Minimal complete definition

create, load, store

Methods

create :: config -> m database Source #

load :: database -> ByteString -> m (Maybe ByteString) Source #

store :: database -> ByteString -> ByteString -> m () Source #

Instances

Monad m => RadixDatabase () (StateT (Map ByteString ByteString) m) () Source #
Instance details Defined in Network.DFINITY.RadixTree.Types Methods create :: () -> StateT (Map ByteString ByteString) m () Source # load :: () -> ByteString -> StateT (Map ByteString ByteString) m (Maybe ByteString) Source # store :: () -> ByteString -> ByteString -> StateT (Map ByteString ByteString) m () Source #
MonadResource m => RadixDatabase (FilePath, Options) m DB Source #
Instance details Defined in Network.DFINITY.RadixTree.Types Methods create :: (FilePath, Options) -> m DB Source # load :: DB -> ByteString -> m (Maybe ByteString) Source # store :: DB -> ByteString -> ByteString -> m () Source #

Types

data RadixError Source #

Constructors

InvalidArgument String
StateRootDoesNotExist RadixRoot

Instances

Eq RadixError Source #
Instance details Defined in Network.DFINITY.RadixTree.Types Methods (==) :: RadixError -> RadixError -> Bool # (/=) :: RadixError -> RadixError -> Bool #
Data RadixError Source #
Instance details Defined in Network.DFINITY.RadixTree.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RadixError -> c RadixError # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RadixError # toConstr :: RadixError -> Constr # dataTypeOf :: RadixError -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RadixError) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RadixError) # gmapT :: (forall b. Data b => b -> b) -> RadixError -> RadixError # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RadixError -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RadixError -> r # gmapQ :: (forall d. Data d => d -> u) -> RadixError -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RadixError -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RadixError -> m RadixError # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RadixError -> m RadixError # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RadixError -> m RadixError #
Show RadixError Source #
Instance details Defined in Network.DFINITY.RadixTree.Types Methods showsPrec :: Int -> RadixError -> ShowS # show :: RadixError -> String # showList :: [RadixError] -> ShowS #
Exception RadixError Source #
Instance details Defined in Network.DFINITY.RadixTree.Types Methods toException :: RadixError -> SomeException # fromException :: SomeException -> Maybe RadixError # displayException :: RadixError -> String #

type RadixRoot = ShortByteString Source #

data RadixTree database Source #

Create

createRadixTree Source #

Arguments

:: RadixDatabase config m database
=> Int	Bloom filter size in bits.
-> Int	LRU cache size in items.
-> Maybe RadixRoot	Previous state root.
-> config	Database configuration.
-> m (RadixTree database)

Create a radix tree.

subtreeRadixTree Source #

Arguments

:: RadixDatabase config m database
=> RadixRoot	State root.
-> RadixTree database	Radix tree.
-> m (RadixTree database)

Create a radix tree from a radix tree.

Insert

insertRadixTree Source #

Arguments

:: RadixDatabase config m database
=> ByteString	Key.
-> ByteString	Value.
-> RadixTree database	Radix tree.
-> m (RadixTree database)

Insert a key and value into a radix tree.

Delete

deleteRadixTree Source #

Arguments

:: RadixDatabase config m database
=> ByteString	Key.
-> RadixTree database	Radix tree.
-> m (RadixTree database)

Delete a value from a radix tree.

Merkleize

merkleizeRadixTree Source #

Arguments

:: RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m (RadixRoot, RadixTree database)

Merkleize a radix tree. This will flush the buffer to disk.

Query

lookupRadixTree Source #

Arguments

:: RadixDatabase config m database
=> ByteString	Key.
-> RadixTree database	Radix tree.
-> m (Maybe (ByteString, RadixTree database))

A convenient alias for lookupNonMerkleizedRadixTree.

lookupMerkleizedRadixTree Source #

Arguments

:: RadixDatabase config m database
=> ByteString	Key.
-> RadixTree database	Radix tree.
-> m (Maybe (ByteString, RadixTree database))

Lookup a value in a Merkleized radix tree.

lookupNonMerkleizedRadixTree Source #

Arguments

:: RadixDatabase config m database
=> ByteString	Key.
-> RadixTree database	Radix tree.
-> m (Maybe (ByteString, RadixTree database))

Lookup a value in a non-Merkleized radix tree.

Test

isEmptyRadixTree Source #

Arguments

:: RadixTree database	Radix tree.
-> Bool

Check if a radix tree is empty.

isValidRadixRoot Source #

Arguments

:: RadixDatabase config m database
=> RadixRoot	State root.
-> RadixTree database	Radix tree.
-> m Bool

Check if a state root is valid.

Stream

sourceMerkleizedRadixTree Source #

Arguments

:: MonadResource m
=> RadixDatabase config (ConduitM () ByteString m) database
=> [Bool]	Bit mask.
-> Int	LRU cache size in items.
-> BoundedChan RadixRoot	Terminal state root producer.
-> RadixTree database	Radix tree.
-> ConduitM () ByteString m ()

Create a conduit from a Merkleized radix tree.

sinkMerkleizedRadixTree Source #

Arguments

:: MonadResource m
=> RadixDatabase config (ConduitM ByteString () m) database
=> RadixRoot	Target state root.
-> BoundedChan RadixRoot	Terminal state root consumer.
-> RadixTree database	Radix tree.
-> ConduitM ByteString () m (Either [RadixRoot] (RadixTree database))

Create a Merkleized radix tree from a conduit.

Debug

contentsRadixTree Source #

Arguments

:: RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m [(ByteString, ByteString)]

A convenient alias for contentsNonMerkleizedRadixTree.

contentsMerkleizedRadixTree Source #

Arguments

:: RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m [(ByteString, ByteString)]

Get the contents of a Merkleized radix tree.

contentsNonMerkleizedRadixTree Source #

Arguments

:: RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m [(ByteString, ByteString)]

Get the contents of a non-Merkleized radix tree.

printRadixTree Source #

Arguments

:: MonadIO m
=> RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m ()

A convenient alias for printNonMerkleizedRadixTree.

printMerkleizedRadixTree Source #

Arguments

:: MonadIO m
=> RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m ()

Print a Merkleized radix tree.

printNonMerkleizedRadixTree Source #

Arguments

:: MonadIO m
=> RadixDatabase config m database
=> RadixTree database	Radix tree.
-> m ()

Print a non-Merkleized radix tree.