Tree
provides immutable, in-memory partial mirror of the store, with lazy reads and delayed writes.
Trees are like staging area in Git: they are immutable temporary non-persistent areas (they disappear if the host crash), held in memory for efficiency, where reads are done lazily and writes are done only when needed on commit: if you modify a key twice, only the last change will be written to the store when you commit.
Constructorsempty
is the empty tree. The empty tree does not have associated backend configuration values, as they can perform in-memory operation, independently of any given backend.
val of_contents : ?metadata :metadata -> contents -> tree
of_contents c
is the subtree built from the contents c
.
of_node n
is the subtree built from the node n
.
val kind : tree -> key -> [ `Contents | `Node ] option Lwt.t
kind t k
is the type of s
in t
. It could either be a tree node or some file contents. It is None
if k
is not present in t
.
list t key
is the list of files and sub-nodes stored under k
in t
.
Diffsdiff x y
is the difference of contents between x
and y
.
Manipulating Contentsmem t k
is true iff k
is associated to some contents in t
.
find_all t k
is Some (b, m)
if k
is associated to the contents b
and metadata m
in t
and None
if k
is not present in t
.
find
is similar to find_all
but it discards metadata.
Same as find_all
but raise Invalid_arg
if k
is not present in t
.
Same as get_all
but ignore the metadata.
add t k c
is the tree where the key k
is bound to the contents c
but is similar to t
for other bindings.
remove t k
is the tree where k
bindings has been removed but is similar to t
for other bindings.
Manipulating Subtreesmem_tree t k
is false iff find_tree k = None
.
find_tree t k
is Some v
if k
is associated to v
in t
. It is None
if k
is not present in t
.
get_tree t k
is v
if k
is associated to v
in t
. Raise Invalid_arg
if k
is not present in t
.
add_tree t k v
is the tree where the key k
is bound to the tree v
but is similar to t
for other bindings
merge
is the 3-way merge function for trees.
Foldsval empty_marks : unit -> marks
empty_marks ()
is an empty collection of marks.
type 'a force = [
| `True
| `False of key -> 'a -> 'a Lwt.t
]
The type for fold
's force
parameter. `True
forces the fold to read the objects of the lazy nodes. `False f
is applying f
on every lazy node instead.
type uniq = [
| `False
| `True
| `Marks of marks
]
The type for fold
's uniq
parameters. `False
folds over all the nodes. `True
does not recurse on nodes already seen. `Marks m
uses the collection of marks m
to store the cache of keys: the fold will modify m
. This can be used for incremental folds.
The type for fold
's pre
and post
parameters.
fold f t acc
folds f
over t
's leafs.
For every node n
, ui n
is a leaf node, call f path n
. Otherwise:
Call pre path n
. By default pre
is the identity; Recursively call fold
on each children, in lexicographic order; Call post path n
; By default post
is the identity. See force
for details about the force
parameters. By default it is `True
.
See uniq
for details about the uniq
parameters. By default it is `False
.
Statstype stats = {
nodes : int;
leafs : int;
skips : int;
depth : int;
width : int;
}
pp_stats
is the pretty printer for tree statistics.
stats ~force t
are t
's statistics. If force
is true, this will force the reading of lazy nodes. By default it is false
.
Concrete TreesThe type for concrete trees.
of_concrete c
is the subtree equivalent to the concrete tree c
.
to_concrete t
is the concrete tree equivalent to the subtree t
.
Cachesval clear : ?depth :int -> tree -> unit
clear ?depth t
clears all the cache in the tree t
for subtrees with a depth higher than depth
. If depth
is not set, all the subtrees are cleared.
type counters = {
mutable contents_hash : int;
mutable contents_find : int;
mutable contents_add : int;
mutable node_hash : int;
mutable node_mem : int;
mutable node_add : int;
mutable node_find : int;
mutable node_val_v : int;
mutable node_val_find : int;
mutable node_val_list : int;
}
val dump_counters : unit Fmt.t
val reset_counters : unit -> unit
val inspect : tree -> [ `Contents | `Node of [ `Map | `Hash | `Value ] ]
Import/Exporthash r c
it c
's hash in the repository r
.
of_hash r h
is the the tree object in r
having h
as hash, or None
is no such tree object exists.
shallow r h
is the shallow tree object with the hash h
. No check is performed to verify if h
actually exists in r
.