package irmin
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=6e430cf44aee5ffdc94f6bfad8dbc401e3ea036ed1fbcf2a8697198ecbf6d412
sha512=b969d0913f0776384fafc4f138cb5187a921e827fd9940d0b350601e1913bdecdfc5acc62ec0ff7c6906e230950a68b39bd886ba3fe37be52e1c6117ddce1791
doc/irmin/Irmin/Maker/argument-1-CA/index.html
Parameter Maker.CA
A content-addressable store is an indexed read-write store in which values are keyed directly by their hashes.
Parameters
Signature
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 : [> Perms.read ] t -> key -> bool Lwt.tmem t k is true iff k is present in t.
val find : [> 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 : [> 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 : [> 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 :
Perms.read t ->
([ Perms.read | 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 -> Perms.read t Lwt.tv config is a function returning fresh store handles, with the configuration config, which is provided by the backend.