package octez-internal-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65
doc/irmin_mem/Irmin_mem/Content_addressable/index.html
Module Irmin_mem.Content_addressableSource
An in-memory store for content-addressable values.
A content-addressable store is an indexed read-write store in which values are keyed directly by their hashes.
Parameters
module Hash : Irmin.Hash.Smodule Value : Irmin.Type.SSignature
Read-only stores
Read-only stores are store where it is only possible to read existing values.
type key = Hash.tThe type for keys.
type value = Value.tThe type for raw values.
val mem : [> Irmin.Perms.read ] t -> key -> bool Lwt.tmem t k is true iff k is present in t.
val find : [> Irmin.Perms.read ] t -> key -> value option Lwt.tfind t k is Some v if k is associated to v in t and None is k is not present in t.
val add : [> Irmin.Perms.write ] t -> value -> key Lwt.tWrite the contents of a value to the store. It's the responsibility of the content-addressable store to generate a consistent key.
val unsafe_add : [> Irmin.Perms.write ] t -> key -> value -> unit Lwt.tSame as add but allows specifying the key directly. The backend might choose to discard that key and/or can be corrupt if the key scheme is not consistent.
close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.
val batch :
Irmin.Perms.read t ->
([ Irmin.Perms.read | Irmin.Perms.write ] t -> 'a Lwt.t) ->
'a Lwt.tbatch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.
val v : Irmin__.Conf.t -> Irmin.Perms.read t Lwt.tv config is a function returning fresh store handles, with the configuration config, which is provided by the backend.