package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=535254ca443858bfc9e540535977fed63e9206d4b78c5cac0239d1e6657b5c78
sha512=fa18557fcf808121a0495de707c6f7bff4a69197b310480816648adafd4a659b5673a1f5bbf4574f517b7d93253735ef7798b0c365d87afac60675007ef19b54
doc/irmin-pack.unix/Irmin_pack_unix/Pack_store/Make/index.html
Module Pack_store.Make
Source
Parameters
module Fm : File_manager.S
module Hash : Irmin.Hash.S with type t = Fm.Index.key
module Val :
Irmin_pack.Pack_value.Persistent
with type hash := Hash.t
and type key := Hash.t Irmin_pack.Pack_key.t
Signature
include Irmin_pack.Indexable.S
with type key = Hash.t Irmin_pack.Pack_key.t
with type hash = Hash.t
with type value = Val.t
include Irmin.Indexable.S
with type key = Hash.t Irmin_pack.Pack_key.t
with type hash = Hash.t
with type value = Val.t
Read-only stores
Read-only stores are store where it is only possible to read existing values.
The type for stores. The 'a
phantom type carries information about the store mutability.
The type for keys.
mem t k
is true iff k
is present in t
.
find t k
is Some v
if k
is associated to v
in t
and None
is k
is not present in t
.
close t
frees up all the resources associated with t
. Any operations run on a closed handle will raise Closed
.
Indexing maps the hash of a value to a corresponding key of that value in the store. For stores that are addressed by hashes directly, this is typically fun _t h -> Lwt.return (Key.of_hash h)
; for stores with more complex addressing schemes, index
may attempt a lookup operation in the store.
In general, indexing is best-effort and reveals no information about the membership of the value in the store. In particular:
index t hash = Some key
doesn't guaranteemem t key
: the value with hashhash
may still be absent from the store;
index t hash = None
doesn't guarantee that there is nokey
such thatmem t key
andKey.to_hash key = hash
: the value may still be present in the store under a key that is not indexed.
val batch :
Irmin.Perms.read t ->
([ Irmin.Perms.read | Irmin.Perms.write ] t -> 'a Lwt.t) ->
'a Lwt.t
batch t f
applies the writes in f
in a separate batch. The exact guarantees depend on the implementation.
Overwrite unsafe_add
to work with a read-only database handler.
val v :
config:Irmin.Backend.Conf.t ->
fm:file_manager ->
dict:dict ->
Irmin.Perms.read t Lwt.t
val integrity_check :
offset:Optint.Int63.t ->
length:int ->
hash ->
_ t ->
(unit, [ `Wrong_hash | `Absent_value ]) result
Read the entry prefix at offset off
.
Returns the key and the kind of an object indexed by hash.