package irmin-pack

You can search for identifiers within the package.

in-package search v0.2.0

Irmin backend which stores values in a pack file

Install

sha256=92a9de7a0a2a35c2feba0c35a806b1f0df24c1c0d15164eebf3f919296d26715

sha512=0203ec5117a851ad5afeb2f9091659b4e142e231b6b945caab93f4d7beb23397c8ac43f7056e91d18f4bff0be1062f6ae966d221f877c229328c0cbbf29fd9f0

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

val key : t -> contents_key option

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

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.

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