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.6.1.tbz
sha256=11fc2570bdbfd48478c89113fc801084a84a9a2c12d9bf8c64e05ce64ae19bd7
sha512=2171699ca24dec5c9c908a2676b272e034c14eb17f7052a794535e52af0be40be68a689e59c0a640ee244b11703320483f4d0c261542e6242ba23a8f1272b9b0

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.

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

The type for version numbers.

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;
}