package irmin-pack

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

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-3.4.2.tbz
sha256=964512f77697947a73dd1875c634d6804e98f14167c5aadd3c4f85b5f30ffb53
sha512=d56d3285daa2dd36f1eaff867af5c8f44c61bba4de1a5c7bb5347652dbc460c343483ab61de1a9302f664af357eacc964dc5c8b4477f6d01372dc028b162e98b

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.