Module Seqdb_containers

module Seqdb_containers: sig .. end

Persistent containers

module Superblock: sig .. end

The Seqdb_containers.Superblock module reads and writes the superblock of a Kvseq, Hindex, or Perm file.

module Sb_consts: sig .. end

Descriptions of the variables that may occur in superblocks can be found in the following Sb_consts module.

module Hash_algo: sig .. end

The Hash_algo module defines the available hash algorithm - which is currently only one.

module type POINTABLE = sig .. end

A module of type POINTABLE describes a container with entries that can be pointed to.

module type HASHABLE = sig .. end

A module of type HASHABLE describes a container where the entries can be hashed, i.e.

module type KVSEQ = sig .. end

The module type KVSEQ is the output type of the Kvseq implementation, that means it describes all the functions to read/write Kvseq files.

module Kvseq: KVSEQ

The basic version of Kvseq where pointers are plain file positions.

module Hpointer: functor (C : HASHABLE) -> sig .. end

This functor adds a hash value of the key to every pointer.

module Kvseq_hp: KVSEQ

A version of KVSEQ using pointers with key hashes.

module type HINDEX = sig .. end

Output type of Hindex, that means it describes all the functions to read/write Hindex files.

module Hindex: functor (C : HASHABLE) -> HINDEX  with module Container = C

Default implementation of HINDEX.

module Autoindex: functor (C : HASHABLE) -> HINDEX  with module Container = C

This HINDEX implementation can cope with index files that have either CELLSZ=1 or CELLSZ=2.

Note that the following file format, Perm, has not yet had the chance to mature.

module type PERM = sig .. end

Output type of Perm

module Perm: functor (C : HASHABLE) -> PERM  with module Container = C

Default implementation of the PERM modtype