package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-2.10.0.tbz
sha256=58b4d058252fc3fca27aa4704594758ea17b5b549076495b53dea7217bd6e64a
sha512=3f7d7817b708d2be41bf81fb7c8f637e0331cc73ffc49d54ae809982d5f258f62255c892ed22c58688034ffa0aa7d32cb7fadb1b188a22ff0ddf80352da3d28b

doc/irmin-pack.layered/Irmin_pack_layered/Maker/Tree/Contents/index.html

Module Tree.Contents

Operations on lazy tree contents.

type t

The type of lazy tree contents.

val hash : ?cache:bool -> t -> hash

hash t is the hash of the contents value returned when t is forced successfully.

caching

cache regulates the caching behaviour regarding the node's internal data which are be lazily loaded from the backend.

cache defaults to true which may greatly reduce the IOs and the runtime but may also grealy increase the memory consumption.

cache = false doesn't replace a call to clear, it only prevents the storing of new data, it doesn't discard the existing one.

val force : t -> contents or_error Lwt.t

force t forces evaluation of the lazy content value t, or returns an error if no such value exists in the underlying repository.

val force_exn : t -> contents Lwt.t

Equivalent to force, but raises an exception if the lazy content value is not present in the underlying repository.

val clear : t -> unit

clear t clears t's cache.

OCaml

Innovation. Community. Security.