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.