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 (9)

Authors

T

Thomas Gazagnaire

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.11.0.tbz

sha256=09996fbcc2c43e117a9bd8e9028c635e81cccb264d5e02d425ab8b06bbacdbdb

sha512=0391a6bf7b94a1edd50a3a8df9e58961739fa78d7d689d61f56bc87144483bad2ee539df595c33d9d52c29b3458da5dddf3a73b5eb85e49c4667c26d2cd46be1

doc/irmin-pack.unix/Irmin_pack_unix/KV/Make/Snapshot/index.html

Module `Make.Snapshot`Source

Sourcetype kinded_hash =

| Contents of hash * metadata
| Node of hash

Sourceval kinded_hash_t : kinded_hash Irmin.Type.t

Sourcetype entry = {

step : string;
hash : kinded_hash;

}

Sourceval entry_t : entry Irmin.Type.t

Sourcetype inode_tree = {

depth : int;
length : int;
pointers : (int * hash) list;

}

Sourceval inode_tree_t : inode_tree Irmin.Type.t

Sourcetype v =

| Inode_tree of inode_tree
| Inode_value of entry list

Sourceval v_t : v Irmin.Type.t

Sourcetype inode = {

v : v;
root : bool;

}

Sourceval inode_t : inode Irmin.Type.t

Sourcetype t =

| Inode of inode
| Blob of Backend.Contents.Val.t

Sourceval t : t Irmin.Type.t

Source

val 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