package cactus

You can search for identifiers within the package.

in-package search v0.2.0

package cactus

cactus
- Btree
  - Index
    
    Make
    
    Key
    
    Value
    
    S
    
    Stats
  - Input
    
    Default
    
    Key
    
    Size
    
    Debug
    
    Value
    
    Key
    
    Size
    
    Debug
    
    Value
  - Make
    
    InKey
    
    InValue
    
    Private
    
    Common
    
    Address
    
    Kind
    
    Magic
    
    Pointer
    
    Version
    
    Entry
    
    Key
    
    Value
    
    Leaf
    
    Node
    
    Params
    
    Debug
    
    Store
    
    Common
    
    Address
    
    Kind
    
    Magic
    
    Pointer
    
    Version
    
    Page
    
    Private
    
    Size
    
    Debug
  - Private
    
    Data
    
    Entry
    
    Key
    
    Value
    
    K
    
    Make
    
    InKey
    
    InValue
    
    Key
    
    Value
    
    V
    
    Index_stats
    
    Stats
    
    Btree
    
    Common
    
    Func
    
    Miscellaneous
    
    Nodes
    
    Store
    
    Utils
    
    Syscalls
    
    Tag
    
    Utils
  - S
    
    Private
    
    Common
    
    Address
    
    Kind
    
    Magic
    
    Pointer
    
    Version
    
    Entry
    
    Key
    
    Value
    
    Leaf
    
    Node
    
    Params
    
    Debug
    
    Store
    
    Common
    
    Address
    
    Kind
    
    Magic
    
    Pointer
    
    Version
    
    Page
    
    Private

Legend:
Library
Module
Module type
Parameter
Class
Class type

exception RandomFailure

type t

The type for store handles.

type address = int

The type of page addresses.

type page

The type of pages.

module Common : sig ... end

module Page : sig ... end

val init : root:string -> t

init root opens a store at path root.

val root : t -> address

root t is the address of the root of the btree.

val reroot : t -> address -> unit

reroot s a changes the address of the root of s to a.

val load : t -> address -> page

load t a loads in memory the page at address a.

val reload : t -> address -> unit

reload t a moves a between caches. Called after a newly created page, it adds it to the right level of cache.

val release : t -> unit

release store tells the store that no loaded pages is going to be written on. This allows the store to clean part of the cache, and must be called as frequently as possible.

val clear_cache : t -> unit

val allocate : t -> address

allocate t allocates a new page (with junk contents) and returns the address of the new page.

val deallocate : t -> address -> unit

deallocate t a deallocates the page at the address a.

val flush : t -> unit

val fsync : t -> unit

val clear : t -> unit

clear t removes every binding in t.

val close : t -> unit

val iter : t -> (address -> page -> unit) -> unit

iter t f applies f on all alive pages in the btree.

val pp_header : t Fmt.t

module Private : sig ... end