package irmin-pack

You can search for identifiers within the package.

in-package search v0.2.0

Irmin backend which stores values in a pack file

Install

Dune Dependency

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

Authors

T

Thomas Gazagnaire

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.7.1.tbz

sha256=8d1a49318bda711ed44d9ea27ecd044b1d650390633d5b08f76590689c22056f

sha512=2995e6acc53dee2c59bf473c7c16c74daebfa193df552ec83ffe88fe598e26d4d8ff5da4f0cd575adaa49efa4b317d74f2c814c1b5601bed3833d76f377b6da7

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

Module `Irmin_pack.Pack_value`Source

This module defines abstractions over entries in the pack file, which are encoded as follows:

  ┌────────┬────────┬──────────────┬─────────┐
  │  Hash  │  Kind  │  Len(Value)? │  Value  │
  └────────┴────────┴──────────────┴─────────┘
  ┆<┄ H ┄┄>┆<┄ K ┄┄>┆<┄┄┄┄ L? ┄┄┄┄>┆<┄┄ V ┄┄>┆
  ┆<┄┄┄┄┄┄┄┄┄┄┄ entry length, E ┄┄┄┄┄┄┄┄┄┄┄┄>┆

The fields are as follows:

Hash: the (fixed-length) hash of the data stored in this entry;

Kind: the kind of data being stored (contents, nodes, commits etc.), encoded as a single "magic" character;

Len(Value): an optional length header for the Value section of the entry (not including the length of the length header itself), encoded using a variable-length encoding (LEB128). The presence of a length header is determined by the Kind character.

Value: the data itself.

The length of the overall pack entry, as referenced in the Pack_index or in a direct Pack_key.t, is equal to E = H + K + L + V.

Sourcemodule Kind : sig ... end

Sourcemodule type S = sig ... end

Sourcemodule type Config = sig ... end

Source

module Of_contents
  (_ : Config)
  (Hash : Irmin.Hash.S)
  (Key : sig ... end)
  (Contents : Irmin.Contents.S) : 
  S with type t = Contents.t and type hash = Hash.t and type key = Key.t