package irmin-pack

  1. Overview
  2. No Docs
Irmin backend which stores values in a pack file

Install 

dune-project
 Dependency

github.com Edit opam file Versions (9)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.7.2.tbz
sha256=6aa5ba4c6a0233747d4bd3ab396f2b3a33bb80f9d8ed4a178c83a035033c0e52
sha512=8a5506a57e8569a11c883ca25b3c60ae7a9a03c2da111668193d7b4296434c43f1a310e78f189e4b38c234da790259d2961c6a0ae481282c18bb97f618fccfb6

doc/irmin-pack.unix/Irmin_pack_unix/Pack_store/Make/index.html

Module Pack_store.MakeSource

Parameters

module Dict : Dict.S with module Fm = Fm
module Dispatcher : Dispatcher.S with module Fm = Fm
module Hash : Irmin.Hash.S with type t = Fm.Index.key
module Val : Pack_value.Persistent with type hash := Hash.t and type key := Hash.t Pack_key.t
module Errs : Io_errors.S with module Io = Fm.Io

Signature

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.

Sourcetype -'a t

The type for stores. The 'a phantom type carries information about the store mutability.

The type for keys.

Sourcetype value = Val.t

The type for raw values.

Sourceval mem : [> Irmin.Perms.read ] t -> key -> bool Lwt.t

mem t k is true iff k is present in t.

Sourceval find : [> Irmin.Perms.read ] t -> key -> value option Lwt.t

find t k is Some v if k is associated to v in t and None is k is not present in t.

Sourceval close : 'a t -> unit Lwt.t

close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.

Sourcetype hash = Hash.t

The type of hashes of value.

Sourceval index : [> Irmin.Perms.read ] t -> hash -> key option Lwt.t

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 guarantee mem t key: the value with hash hash may still be absent from the store;
  • index t hash = None doesn't guarantee that there is no key such that mem t key and Key.to_hash key = hash: the value may still be present in the store under a key that is not indexed.

batch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.

Sourcemodule Key : Irmin.Key.S with type t = key and type hash = hash
Sourceval add : 'a t -> value -> key Lwt.t

Overwrite add to work with a read-only database handler.

Sourceval unsafe_add : 'a t -> hash -> value -> key Lwt.t

Overwrite unsafe_add to work with a read-only database handler.

Sourceval index_direct : _ t -> hash -> key option
Sourceval unsafe_append : ensure_unique:bool -> overcommit:bool -> 'a t -> hash -> value -> key
Sourceval unsafe_mem : 'a t -> key -> bool
Sourceval unsafe_find : check_integrity:bool -> 'a t -> key -> value option
Sourcetype file_manager = Fm.t
Sourcetype dict = Dict.t
Sourcetype dispatcher = Dispatcher.t
Sourceval v : config:Irmin.Backend.Conf.t -> fm:file_manager -> dict:dict -> dispatcher:dispatcher -> Irmin.Perms.read t
Sourceval integrity_check : offset:Optint.Int63.t -> length:int -> hash -> _ t -> (unit, [ `Wrong_hash | `Absent_value ]) result
Sourcemodule Entry_prefix : sig ... end
Sourceval read_and_decode_entry_prefix : off:Optint.Int63.t -> dispatcher -> Entry_prefix.t

Read the entry prefix at offset off.

Sourceval index_direct_with_kind : 'a t -> hash -> (key * Irmin_pack.Pack_value.Kind.t) option

Returns the key and the kind of an object indexed by hash.

Sourceval purge_lru : 'a t -> unit
Sourceval key_of_offset : 'a t -> Optint.Int63.t -> key

Returns the key associated with the offset.

Sourceval unsafe_find_no_prefetch : 'a t -> key -> value option

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.

Sourceval get_offset : 'a t -> key -> Optint.Int63.t

Returns the offset associated with the key.

Sourceval get_length : 'a t -> key -> int

Returns the length of the object associated with the key.