package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

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 = Fm.Io
module Errs : Io_errors.S with module Io = Io
type open_error := [
  1. | `Corrupted_mapping_file of string
  2. | `No_such_file_or_directory
]
val create : ?report_file_sizes:(file_sizes -> unit) -> root:string -> generation:int -> register_entries: (register_entry:(off:Optint.Int63.t -> len:int -> unit) -> unit) -> unit -> (t, Errs.t) Stdlib.result

create creates inside the directory root a mapping file. It never raises exceptions.

register_entries is a user callback that is responsible for calling register_entry for each live entry. Duplicates allowed, no specfic order expected.

Returns an error if the platform is not 64bits.

Creates temporary files in root that are unlinked before the function returns.

val open_map : root:string -> generation:int -> (t, [> open_error ]) Stdlib.result

open_map ~root ~generation opens a mapping file.

val iter : t -> (off:Optint.Int63.t -> len:int -> unit) -> (unit, Errs.t) Stdlib.result

iter 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) -> unit

Similar to iter mapping f but raises exceptions.

type entry = {
  1. off : Optint.Int63.t;
  2. poff : Optint.Int63.t;
  3. len : int;
}
val find_nearest_leq : t -> Optint.Int63.t -> entry option

find_nearest_leq t off returns the entry in t whose offset is the nearest <= the given off

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct