package irmin-pack

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

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (9)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.10.0.tbz
sha256=92a9de7a0a2a35c2feba0c35a806b1f0df24c1c0d15164eebf3f919296d26715
sha512=0203ec5117a851ad5afeb2f9091659b4e142e231b6b945caab93f4d7beb23397c8ac43f7056e91d18f4bff0be1062f6ae966d221f877c229328c0cbbf29fd9f0

doc/irmin-pack.unix/Irmin_pack_unix/Inode/Make_persistent/argument-3-Inter/Raw/index.html

Module Inter.Raw

include Irmin_pack.Pack_value.S with type hash = hash with type key = key
include Irmin.Type.S
type t
val t : t Repr__.Type.t
type hash = hash
type key = key
val hash : t -> hash
val length_header : Irmin_pack.Pack_value.Kind.t -> [ `Varint ] option

Describes the length header formats for the data sections of pack entries.

val weight : t -> Irmin_pack__.Pack_value_intf.weight

weight t is the t's LRU weight.

val encode_bin : dict:(string -> int option) -> offset_of_key:(key -> Optint.Int63.t option) -> hash -> t Irmin.Type.encode_bin
val decode_bin : dict:(int -> string option) -> key_of_offset:(Optint.Int63.t -> key) -> key_of_hash:(hash -> key) -> t Irmin.Type.decode_bin
val decode_bin_length : string -> int -> int
val to_kinded : t -> Irmin_pack__.Pack_value_intf.kinded

to_kinded t returns a kinded version of t.

val of_kinded : Irmin_pack__.Pack_value_intf.kinded -> t

of_kinded k is the inverse of to_kinded t.

It is expected that an implementation only works for k that is returned from to_kinded t and will raise an exception otherwise.

val depth : t -> int option
exception Invalid_depth of {
  1. expected : int;
  2. got : int;
  3. v : t;
}
val decode_children_offsets : entry_of_offset:(Optint.Int63.t -> 'a) -> entry_of_hash:(hash -> 'a) -> string -> int ref -> 'a list