package carton

  1. Overview
  2. Docs
type bigstring = (char, Stdlib.Bigarray.int8_unsigned_elt, Stdlib.Bigarray.c_layout) Stdlib.Bigarray.Array1.t
type 'uid idx
type optint = Optint.t
val make : bigstring -> uid_ln:int -> uid_rw:('uid -> string) -> uid_wr:(string -> 'uid) -> 'uid idx
val find : 'uid idx -> 'uid -> (optint * int64) option
val iter : f:(uid:'uid -> offset:int64 -> crc:optint -> unit) -> 'uid idx -> unit
val exists : 'uid idx -> 'uid -> bool
val max : 'uid idx -> int
val get_uid : 'uid idx -> int -> 'uid
val get_offset : 'uid idx -> int -> int64
val get_crc : 'uid idx -> int -> optint
module type UID = sig ... end
type 'uid entry = {
  1. crc : optint;
  2. offset : int64;
  3. uid : 'uid;
}
module N (Uid : UID) : sig ... end

Memory safe IDX decoder.

The goal of this library is to provide a way to decode the IDX file as a stream.

module Device : sig ... end
module M (IO : sig ... end) (Uid : sig ... end) : sig ... end