package irmin

You can search for identifiers within the package.

in-package search v0.2.0

Irmin, a distributed database that follows the same design principles as Git

Install

sha256=6aa5ba4c6a0233747d4bd3ab396f2b3a33bb80f9d8ed4a178c83a035033c0e52

sha512=8a5506a57e8569a11c883ca25b3c60ae7a9a03c2da111668193d7b4296434c43f1a310e78f189e4b38c234da790259d2961c6a0ae481282c18bb97f618fccfb6

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. See caching for an explanation of the cache parameter.

Sourceval key : t -> contents_key option

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

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

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.

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.

On This Page