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.unix/Irmin_pack_unix/Maker/Make/Snapshot/index.html

Module Make.SnapshotSource

Sourcetype kinded_hash =
  1. | Contents of hash * metadata
  2. | Node of hash
Sourceval kinded_hash_t : kinded_hash Irmin.Type.t
Sourcetype entry = {
  1. step : string;
  2. hash : kinded_hash;
}
Sourceval entry_t : entry Irmin.Type.t
Sourcetype inode_tree = {
  1. depth : int;
  2. length : int;
  3. pointers : (int * hash) list;
}
Sourceval inode_tree_t : inode_tree Irmin.Type.t
Sourcetype v =
  1. | Inode_tree of inode_tree
  2. | Inode_value of entry list
Sourcetype inode = {
  1. v : v;
  2. root : bool;
}
Sourcetype t =
  1. | Inode of inode
  2. | Blob of Backend.Contents.Val.t
Sourceval export : ?on_disk:[ `Path of string ] -> repo -> (t -> unit Lwt.t) -> root_key:Tree.kinded_key -> int Lwt.t

export ?on_disk repo f ~root_key applies f to all inodes and contents in a rooted tree, with root specified by root_key.

The traversal requires an index to keep track of visited elements.

  • if on_disk is not specified, the index is in memory.
  • if on_disk is `Path path, a temporary index is created at path.

The traversal order is stable. In Inode_tree, it is lexicographic on the index function (see Conf.inode_child_order). In Inode_value, it is lexicographic on the steps.

f is called in post-order, that is f is first called on the leaves, and the last call to f is on the root designated by root_key.

The traversal skips objects that are structurally equal to objects that were already traversed. In other words, export internally uses a hash set in order to guarantee that all the objects passed to f don't hash the same way.

Returns the total number of elements visited.

Sourcemodule Import : sig ... end