type error = | Invalid_header of stringAppear when the header of the IDX file is incorrect.
*)| Invalid_version of int32Appear when the version of the IDX file is wrong.
*)| Invalid_indexAppear when we try to read an area outside the IDX file.
*)| Expected_bigoffset_tableAppear when we try to read a big offset table and we can't catch it.
*)| Invalid_bigoffset_index of intAppear when we try to read a big offset value and we can't catch it.
*)The type error.
Make a new state from a Cstruct.t buffer. You can specify how many elements we can store to the cache. This function returns the state t or an error.
Indeed, in this function we check if the IDX file stored entirely on the Cstruct.t is well-formed. Otherwise, we return an explicit error.
val find : t -> Hash.t -> (Checkseum.Crc32.t * int64) optionfind t hash get the CRC-32 checksum and the absolute offset binded on hash in the IDX file represented by t only if hash exists. Otherwise, it returns None.
val mem : t -> Hash.t -> boolmem t hash returns true if hash exists in the IDX file represented by t. Otherwise, it returns false.
val iter : t -> (Hash.t -> (Checkseum.Crc32.t * int64) -> unit) -> unitIteration in the IDX file.
val fold : t -> (Hash.t -> (Checkseum.Crc32.t * int64) -> 'a -> 'a) -> 'a -> 'aFold in the IDX file.
val cardinal : t -> int