package irmin-pack

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

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-3.11.0.tbz
sha256=09996fbcc2c43e117a9bd8e9028c635e81cccb264d5e02d425ab8b06bbacdbdb
sha512=0391a6bf7b94a1edd50a3a8df9e58961739fa78d7d689d61f56bc87144483bad2ee539df595c33d9d52c29b3458da5dddf3a73b5eb85e49c4667c26d2cd46be1

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.

See `doc/irmin-pack/version-history.md` for other documentation.

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

Innovation. Community. Security.