package octez-internal-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65
doc/irmin_pack_unix/Irmin_pack_unix/Pack_store/Make/index.html
Module Pack_store.MakeSource
Parameters
module Fm : File_manager.Smodule Dispatcher : Dispatcher.S with module Fm = Fmmodule Hash : Irmin.Hash.S with type t = Fm.Index.keymodule Val :
Pack_value.Persistent
with type hash := Hash.t
and type key := Hash.t Pack_key.tmodule Errs : Io_errors.S with module Io = Fm.IoSignature
include Irmin_pack.Indexable.S
with type key = Hash.t Pack_key.t
with type hash = Hash.t
with type value = Val.t
include Irmin.Indexable.S
with type key = Hash.t 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.
type key = Hash.t Pack_key.tThe type for keys.
type value = Val.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.
close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.
type hash = Hash.tThe type of hashes of value.
val index : [> Irmin.Perms.read ] t -> hash -> key option Lwt.tIndexing 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 keydoesn't guaranteemem t key: the value with hashhashmay still be absent from the store;
index t hash = Nonedoesn't guarantee that there is nokeysuch thatmem t keyandKey.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.tbatch 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 ->
dispatcher:dispatcher ->
lru:Lru.t ->
Irmin.Perms.read tval integrity_check :
offset:Optint.Int63.t ->
length:int ->
hash ->
_ t ->
(unit, [ `Wrong_hash | `Absent_value ]) resultRead the entry prefix at offset off.
Returns the key and the kind of an object indexed by hash.
Similar to unsafe_find, returns the value associated with the key in the store but without prefetching the hash and length of the children (or doing any integrity check). As a result, the produced children keys only contain their offset and are not usable without calling key_of_offset first. This function only exists to optimize the GC reachability traversal.