A mapping file is a collection of chunks which contain 3 integers. A length, the global offset (off) of the chunk and the offset of the chunk in the prefix file (poff).
The chunks have consecutive poff with respect to their lengths.
There is no need to close a t because its underlying file-descriptor is always closed.
module Io = Iomodule Errs : Irmin_pack_unix.Io_errors.S with module Io = Ioval create :
?report_mapping_size:(Optint.Int63.t -> unit) ->
root:string ->
generation:int ->
register_entries:
(register_entry:(off:Optint.Int63.t -> len:int -> unit) -> unit) ->
unit ->
(t, Errs.t) Stdlib.resultcreate creates a mapping file inside the directory root.
register_entries is a user callback that is responsible for calling register_entry for each live entry. It must be called with strictly decreasing offsets (or fails otherwise).
Returns an error if the platform is not 64bits.
val open_map :
root:string ->
generation:int ->
(t, [> open_error ]) Stdlib.resultopen_map ~root ~generation opens a mapping file.
val iter :
t ->
(off:Optint.Int63.t -> len:int -> unit) ->
(unit, Errs.t) Stdlib.resultiter mapping f calls f on each (off,len) pair in mapping.
It is guaranteed for the offsets to be iterated in monotonic order.
It is guaranteed that entries don't overlap.
The exceptions raised by f are caught and returned (as long as they are known by Errs).
val iter_exn : t -> (off:Optint.Int63.t -> len:int -> unit) -> unitSimilar to iter mapping f but raises exceptions.
val find_nearest_leq : t -> Optint.Int63.t -> entry optionfind_nearest_leq t off returns the entry in t whose offset is the nearest <= the given off