package index

You can search for identifiers within the package.

in-package search v0.2.0

A platform-agnostic multi-level index for OCaml

Install

sha256=9e2b60bffcad828b2c732cbdfb6c35627443062fb482d08e431035f78e54584a

sha512=44d710f5ef3007abfbbab4bcc8d408e59d55f109fff81c7be6513fb838092039b6af4371f6df14d1746eaa0b9784549ebfecd9cf8b0578fa831281162ba635e3

type t

The type for keys.

val equal : t -> t -> bool

The equality function for keys.

val hash : t -> int

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

val 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.

val encode : t -> string

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

val encoded_size : int

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

val 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.

val pp : t Fmt.t

Formatter for keys