package irmin

  1. Overview
  2. Docs
Irmin, a distributed database that follows the same design principles as Git

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-2.9.1.tbz
sha256=16003a8a873737b0a8ae2a940399b14754c5c2ba506e4511b96df4473e912783
sha512=64682e67c1e9f6b6f6a5f017da7c0d7e5316e2dd139ad8ad7ad43b73003d827fb9f3141c10469986dee47849687c841a297b91d08186f72268c41e026810a647

doc/irmin.mem/Irmin_mem/KV/Tree/Contents/index.html

Module Tree.ContentsSource

Operations on lazy tree contents.

Sourcetype t

The type of lazy tree contents.

Sourceval 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.

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

Sourceval 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.

Sourceval clear : t -> unit

clear t clears t's cache.

OCaml

Innovation. Community. Security.