Database.Liszt.Internal

Documentation

type Key = ByteString

type Tag = Encoding

Tag is an extra value attached to a payload. This can be used to perform a binary search.

data LisztHandle

Constructors

LisztHandle

Fields

• hPayload :: !Handle
• refBuffer :: MVar (Int, ForeignPtr Word8)
• keyCache :: IORef (IntMap Key)
• refModified :: IORef Bool
• handleLock :: MVar ()

openLiszt :: MonadIO m => FilePath -> m LisztHandle

closeLiszt :: MonadIO m => LisztHandle -> m ()

withLiszt :: (MonadIO m, MonadMask m) => FilePath -> (LisztHandle -> m a) -> m a

Writing

clear :: Key -> Transaction ()

Replace the specified key with an empty list.

insertRaw :: Key -> Tag -> Encoding -> Transaction ()

commit :: MonadIO m => LisztHandle -> Transaction a -> m a

type Transaction = StateT TransactionState IO

data TransactionState

Reading

availableKeys :: LisztHandle -> Frame RawPointer -> IO [Key]

Frame

data Frame a

Constructors

Empty

Leaf1 !KeyPointer !(Spine a)

Leaf2 !KeyPointer !(Spine a) !KeyPointer !(Spine a)

Node2 !a !KeyPointer !(Spine a) !a

Node3 !a !KeyPointer !(Spine a) !a !KeyPointer !(Spine a) !a

Tree !Tag !RawPointer !a !a

Leaf !Tag !RawPointer

Instances

Functor Frame

Defined in Database.Liszt.Internal

Methods

fmap :: (a -> b) -> Frame a -> Frame b

(<$) :: a -> Frame b -> Frame a

Foldable Frame

Defined in Database.Liszt.Internal

Methods

fold :: Monoid m => Frame m -> m

foldMap :: Monoid m => (a -> m) -> Frame a -> m

foldr :: (a -> b -> b) -> b -> Frame a -> b

foldr' :: (a -> b -> b) -> b -> Frame a -> b

foldl :: (b -> a -> b) -> b -> Frame a -> b

foldl' :: (b -> a -> b) -> b -> Frame a -> b

foldr1 :: (a -> a -> a) -> Frame a -> a

foldl1 :: (a -> a -> a) -> Frame a -> a

toList :: Frame a -> [a]

null :: Frame a -> Bool

length :: Frame a -> Int

elem :: Eq a => a -> Frame a -> Bool

maximum :: Ord a => Frame a -> a

minimum :: Ord a => Frame a -> a

sum :: Num a => Frame a -> a

product :: Num a => Frame a -> a

Traversable Frame

Defined in Database.Liszt.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Frame a -> f (Frame b)

sequenceA :: Applicative f => Frame (f a) -> f (Frame a)

mapM :: Monad m => (a -> m b) -> Frame a -> m (Frame b)

sequence :: Monad m => Frame (m a) -> m (Frame a)

Eq a => Eq (Frame a)

Defined in Database.Liszt.Internal

Methods

(==) :: Frame a -> Frame a -> Bool

(/=) :: Frame a -> Frame a -> Bool

Show a => Show (Frame a)

Defined in Database.Liszt.Internal

Methods

showsPrec :: Int -> Frame a -> ShowS

show :: Frame a -> String

showList :: [Frame a] -> ShowS

Generic (Frame a)

Defined in Database.Liszt.Internal

Associated Types

type Rep (Frame a) :: * -> *

Methods

from :: Frame a -> Rep (Frame a) x

to :: Rep (Frame a) x -> Frame a

Serialise a => Serialise (Frame a)

Defined in Database.Liszt.Internal

Methods

schemaVia :: Proxy (Frame a) -> [TypeRep] -> Schema

toEncoding :: Frame a -> Encoding

deserialiser :: Deserialiser (Frame a)

constantSize :: Proxy (Frame a) -> Maybe Int

type Rep (Frame a)

Defined in Database.Liszt.Internal

type Rep (Frame a)

decodeFrame :: ByteString -> Frame RawPointer

forceSpine :: NFData a => Frame a -> IO (Frame a)

Fetching

class Fetchable a where

Minimal complete definition

fetchFrame

Methods

fetchFrame :: LisztHandle -> a -> IO (Frame a)

Instances

Fetchable RawPointer

Defined in Database.Liszt.Internal

Methods

fetchFrame :: LisztHandle -> RawPointer -> IO (Frame RawPointer)

data RawPointer

Constructors

RP !Int !Int

Instances

Eq RawPointer

Defined in Database.Liszt.Internal

Methods

(==) :: RawPointer -> RawPointer -> Bool

(/=) :: RawPointer -> RawPointer -> Bool

Show RawPointer

Defined in Database.Liszt.Internal

Methods

showsPrec :: Int -> RawPointer -> ShowS

show :: RawPointer -> String

showList :: [RawPointer] -> ShowS

Generic RawPointer

Defined in Database.Liszt.Internal

Associated Types

type Rep RawPointer :: * -> *

Methods

from :: RawPointer -> Rep RawPointer x

to :: Rep RawPointer x -> RawPointer

NFData RawPointer

Defined in Database.Liszt.Internal

Methods

rnf :: RawPointer -> ()

Serialise RawPointer

Defined in Database.Liszt.Internal

Methods

schemaVia :: Proxy RawPointer -> [TypeRep] -> Schema

toEncoding :: RawPointer -> Encoding

deserialiser :: Deserialiser RawPointer

constantSize :: Proxy RawPointer -> Maybe Int

Fetchable RawPointer

Defined in Database.Liszt.Internal

Methods

fetchFrame :: LisztHandle -> RawPointer -> IO (Frame RawPointer)

type Rep RawPointer

Defined in Database.Liszt.Internal

type Rep RawPointer = D1 (MetaData "RawPointer" "Database.Liszt.Internal" "liszt-0.1-1cOiQgJXwtqKFMyn5HpvuM" False) (C1 (MetaCons "RP" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Footer

fetchRoot :: LisztHandle -> IO (Frame RawPointer)

footerSize :: Int

isFooter :: ByteString -> Bool

lookupSpine :: Fetchable a => LisztHandle -> Key -> Frame a -> IO (Maybe (Spine a))

Spine

type Spine a = [(Int, a)]

spineLength :: Spine a -> Int

type QueryResult = (Tag, RawPointer)

takeSpine :: Fetchable a => LisztHandle -> Int -> Spine a -> [QueryResult] -> IO [QueryResult]

dropSpine :: Fetchable a => LisztHandle -> Int -> Spine a -> IO (Spine a)

takeSpineWhile :: Fetchable a => (Tag -> Bool) -> LisztHandle -> Spine a -> [QueryResult] -> IO [QueryResult]

dropSpineWhile :: Fetchable a => (Tag -> Bool) -> LisztHandle -> Spine a -> IO (Maybe (Int, QueryResult, Spine a))