package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (9)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.7.2.tbz
sha256=6aa5ba4c6a0233747d4bd3ab396f2b3a33bb80f9d8ed4a178c83a035033c0e52
sha512=8a5506a57e8569a11c883ca25b3c60ae7a9a03c2da111668193d7b4296434c43f1a310e78f189e4b38c234da790259d2961c6a0ae481282c18bb97f618fccfb6

doc/irmin-pack/Irmin_pack/Version/index.html

Module Irmin_pack.VersionSource

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.

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

The type for version numbers.

Sourceval to_int : t -> int
Sourceval compare : t -> t -> int
Sourceval latest : t
Sourceval pp : t Fmt.t

pp is the pretty-format for version numbers.

Sourceval to_bin : t -> string

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

Sourceval of_bin : string -> t option

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

Sourceval invalid_arg : string -> 'a

invalid_arg str raises Invalid_argument.

Sourceexception Invalid of {
  1. expected : t;
  2. found : t;
}