Data.BTree.Alloc.Class

A page allocator manages all physical pages.

Classes

class (Applicative m, Monad m) => AllocReaderM m where

A page allocator that can read physical pages.

Minimal complete definition

readNode, readOverflow

Methods

readNode :: (Key key, Value val) => Height height -> NodeId height key val -> m (Node height key val)

Read a page and return the actual node.

readOverflow :: Value val => OverflowId -> m val

Read an overflow page.

Instances

(Functor m, Monad m) => AllocReaderM (DebugT m)

Methods

readNode :: (Key key, Value val) => Height height -> NodeId height key val -> DebugT m (Node height key val)

readOverflow :: Value val => OverflowId -> DebugT m val

class AllocReaderM m => AllocM m where

A page allocator that can write physical pages.

Minimal complete definition

nodePageSize, maxPageSize, maxKeySize, maxValueSize, allocNode, freeNode, allocOverflow, freeOverflow

Methods

nodePageSize :: (Key key, Value val) => m (Height height -> Node height key val -> PageSize)

A function that calculates the hypothetical size of a node, if it were to be written to a page (regardless of the maximum page size).

maxPageSize :: m PageSize

The maximum page size the allocator can handle.

maxKeySize :: m Word64

The maximum key size

maxValueSize :: m Word64

The maximum value size

allocNode :: (Key key, Value val) => Height height -> Node height key val -> m (NodeId height key val)

Allocate a new page for a node, and write the node to the page.

freeNode :: Height height -> NodeId height key val -> m ()

Free the page belonging to the node.

allocOverflow :: Value val => val -> m OverflowId

Allocate a new overflow page, and write the value to the page.

freeOverflow :: OverflowId -> m ()

Free an overflow page.

Instances

(Functor m, Monad m) => AllocM (DebugT m)

Methods

nodePageSize :: (Key key, Value val) => DebugT m (Height height -> Node height key val -> PageSize)

maxPageSize :: DebugT m PageSize

maxKeySize :: DebugT m Word64

maxValueSize :: DebugT m Word64

allocNode :: (Key key, Value val) => Height height -> Node height key val -> DebugT m (NodeId height key val)

freeNode :: Height height -> NodeId height key val -> DebugT m ()

allocOverflow :: Value val => val -> DebugT m OverflowId

freeOverflow :: OverflowId -> DebugT m ()