package irmin-pack

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

Management of disk-format versions.

`V2 introduced the *_v2 kinds and deprecated the *_v1 ones. The upgrade of a pack file to `V2 was done silently the first time a used pushed a *_v2 entry to the pack file.

`V3 introduced the control file. It centralizes all the metadata that used to be contained in the header of other files (e.g. the version of the store used to be stored in each files, it is now solely stored in the control file). The upgrade of a store to `V3 was done silently when opening a store in rw mode.

`V4 introduced the chunked suffix. Upgrade from `V3 happened on first write to the control file.

`V5 introduced the lower layer. Upgrade happened on first write to the control file.

type t = [
  1. | `V1
  2. | `V2
  3. | `V3
  4. | `V4
  5. | `V5
]

The type for version numbers.

val t : t Irmin.Type.t
val to_int : t -> int
val compare : t -> t -> int
val latest : t
val pp : t Fmt.t

pp is the pretty-format for version numbers.

val to_bin : t -> string

to_bin t is the 8-bytes binary representation of t.

val of_bin : string -> t option

of_bin s is Some t is to_bin t is s and None otherwise.

val invalid_arg : string -> 'a

invalid_arg str raises Invalid_argument.

exception Invalid of {
  1. expected : t;
  2. found : t;
}
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