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=7f2f9efe3ed8b0a434ddf819c835f12ec03c21bc6f9ca6b7904407f146e60680

sha512=47a62af9a60a059dd4b40a32d841b1afa87a64e6cd65024dbf26622b30e7187e5cc482279143d87e4216fb94d7c9cfcf4c19bedbe7f930877b200a637a858092

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