package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-3.2.1.tbz
sha256=9cfb7291a7d90ca0e55ece33040ad41e74cadd8c6446e04c33558bc1a1951518
sha512=9605acd77de9aae70ae96554a28594e6ed5beba70a48145c0fc2204b32bb23b843ba98cf034e88391581d5f3495154195c644d64a3aa3f8d3994a9c5518c5cda

doc/irmin-pack.unix/Irmin_pack_unix/Index/Make/Key/index.html

Module Make.KeySource

Sourcetype t = key

The type for keys.

Sourceval t : t Repr.t
Sourceval equal : t -> t -> bool

The equality function for keys.

Sourceval hash : t -> int

Note: Unevenly distributed hash functions may result in performance drops.

Sourceval hash_size : int

The number of bits necessary to encode the maximum output value of hash. `Hashtbl.hash` uses 30 bits.

Overestimating the hash_size will result in performance drops; underestimation will result in undefined behavior.

Sourceval encode : t -> string

encode is an encoding function. The resultant encoded values must have size encoded_size.

Sourceval encoded_size : int

encoded_size is the size of the result of encode, expressed in number of bytes.

Sourceval decode : string -> int -> t

decode s off is the decoded form of the encoded value at the offset off of string s. Must satisfy decode (encode t) 0 = t.

OCaml

Innovation. Community. Security.