Snapshot (p.plebeia.2.0.2.doc.plebeia.Plebeia.Snapshot)

Sourcetype snapshot

The type for snapshot. Using Seq.t inside

Sourcetype t = snapshot

Sourceval encoding : int -> t Data_encoding.encoding

val seq : 
  node:(Node_type.t -> [< `Hash of Hash.t | `View of Node_type.view ]) ->
  Node_type.t ->
  t

Lazy dump of a node and its subnodes

Sourceval save : Lwt_unix.file_descr -> Context.t -> Node_type.t -> unit Lwt.t

Dump the snapshot of Plebeia tree to file_descr.

To reduce the size of the snapshot, it performs perfect hash-consing.

Source

val save_gen : 
  Lwt_unix.file_descr ->
  int ->
  node:(Node_type.t -> [ `Hash of Hash.t | `View of Node_type.view ]) ->
  Node_type.t ->
  unit Lwt.t

Generalized version of save, specifiable how to handle Disk nodes.

node function is to preprocess each node. It is to, for example, * load Disk * load the hash for hashconsing * replace the node by Hash to stop traversal

Source

val load : 
  Hash.Hasher.t ->
  Data_encoding_tools.reader ->
  (Node_type.t * bool) Lwt.t

Load the snapshot file of Plebeia tree from reader.

The entire tree is node-hash computed.

The entire tree is loaded on memory.

load returns a boolean with the loaded node, which indicates whether the node contains Hash _ or not.

Sourceval load' : Hash.Hasher.t -> t -> Node_type.t * bool

Load the snapshot file of Plebeia tree from t.

Sourcemodule Stat : sig ... end

Statistics of the nodes in a snapshot

Sourcemodule Internal : sig ... end