package irmin-pack

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

Install

Dune Dependency

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

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.4.3.tbz
sha256=6e430cf44aee5ffdc94f6bfad8dbc401e3ea036ed1fbcf2a8697198ecbf6d412
sha512=b969d0913f0776384fafc4f138cb5187a921e827fd9940d0b350601e1913bdecdfc5acc62ec0ff7c6906e230950a68b39bd886ba3fe37be52e1c6117ddce1791

doc/irmin-pack.unix/Irmin_pack_unix/KV/Make/Tree/index.html

Module Make.TreeSource

Sourceval metadata_t : metadata Irmin.Type.t
Sourceval contents_t : contents Irmin.Type.t
Sourceval contents_key_t : contents_key Irmin.Type.t
Sourceval empty : unit -> tree
Sourceval singleton : path -> ?metadata:metadata -> contents -> tree
Sourceval of_contents : ?metadata:metadata -> contents -> tree
Sourceval of_node : node -> tree
Sourcetype elt = [
  1. | `Contents of contents * metadata
  2. | `Node of node
]
Sourceval v : elt -> tree
Sourceval kinded_hash_t : [ `Contents of hash * metadata | `Node of hash ] Irmin.Type.t
Sourceval pruned : [ `Contents of hash * metadata | `Node of hash ] -> tree
Sourceval kind : tree -> path -> [ `Contents | `Node ] option Lwt.t
Sourceval is_empty : tree -> bool
Sourceval diff : tree -> tree -> (path * (contents * metadata) Irmin.Diff.t) list Lwt.t
Sourceexception Dangling_hash of {
  1. context : string;
  2. hash : hash;
}
Sourceexception Pruned_hash of {
  1. context : string;
  2. hash : hash;
}
Sourceexception Portable_value of {
  1. context : string;
}
Sourcetype error = [
  1. | `Dangling_hash of hash
  2. | `Portable_value
  3. | `Pruned_hash of hash
]
Sourcetype !'a or_error = ('a, error) result
Sourcemodule Contents : sig ... end
Sourceval mem : tree -> path -> bool Lwt.t
Sourceval find_all : tree -> path -> (contents * metadata) option Lwt.t
Sourceval length : tree -> ?cache:bool -> path -> int Lwt.t
Sourceval find : tree -> path -> contents option Lwt.t
Sourceval get_all : tree -> path -> (contents * metadata) Lwt.t
Sourceval list : tree -> ?offset:int -> ?length:int -> ?cache:bool -> path -> (step * tree) list Lwt.t
Sourceval seq : tree -> ?offset:int -> ?length:int -> ?cache:bool -> path -> (unit -> (step * tree) Seq.node) Lwt.t
Sourceval get : tree -> path -> contents Lwt.t
Sourceval add : tree -> path -> ?metadata:metadata -> contents -> tree Lwt.t
Sourceval update : tree -> path -> ?metadata:metadata -> (contents option -> contents option) -> tree Lwt.t
Sourceval remove : tree -> path -> tree Lwt.t
Sourceval mem_tree : tree -> path -> bool Lwt.t
Sourceval find_tree : tree -> path -> tree option Lwt.t
Sourceval get_tree : tree -> path -> tree Lwt.t
Sourceval add_tree : tree -> path -> tree -> tree Lwt.t
Sourceval update_tree : tree -> path -> (tree option -> tree option) -> tree Lwt.t
Sourceval destruct : tree -> [ `Contents of Contents.t * metadata | `Node of node ]
Sourceval empty_marks : unit -> marks
Sourcetype !'a force = [
  1. | `False of path -> 'a -> 'a Lwt.t
  2. | `True
]
Sourcetype uniq = [
  1. | `False
  2. | `Marks of marks
  3. | `True
]
Sourcetype (!'a, !'b) folder = path -> 'b -> 'a -> 'a Lwt.t
Sourcetype depth = [
  1. | `Eq of int
  2. | `Ge of int
  3. | `Gt of int
  4. | `Le of int
  5. | `Lt of int
]
Sourceval fold : ?order:[ `Random of Random.State.t | `Sorted | `Undefined ] -> ?force:'a force -> ?cache:bool -> ?uniq:uniq -> ?pre:('a, step list) folder -> ?post:('a, step list) folder -> ?depth:depth -> ?contents:('a, contents) folder -> ?node:('a, node) folder -> ?tree:('a, tree) folder -> tree -> 'a -> 'a Lwt.t
Sourcetype stats = Irmin.Of_backend(X).Tree.stats = {
  1. nodes : int;
  2. leafs : int;
  3. skips : int;
  4. depth : int;
  5. width : int;
}
Sourceval stats : ?force:bool -> tree -> stats Lwt.t
Sourcetype concrete = [
  1. | `Contents of contents * metadata
  2. | `Tree of (step * concrete) list
]
Sourceval concrete_t : concrete Irmin.Type.t
Sourceval of_concrete : concrete -> tree
Sourceval to_concrete : tree -> concrete Lwt.t
Sourcemodule Proof : sig ... end
Sourceval clear : ?depth:int -> tree -> unit
Sourcetype counters = Irmin.Of_backend(X).Tree.counters = {
  1. mutable contents_hash : int;
  2. mutable contents_find : int;
  3. mutable contents_add : int;
  4. mutable contents_mem : int;
  5. mutable node_hash : int;
  6. mutable node_mem : int;
  7. mutable node_index : int;
  8. mutable node_add : int;
  9. mutable node_find : int;
  10. mutable node_val_v : int;
  11. mutable node_val_find : int;
  12. mutable node_val_list : int;
}
Sourceval counters : unit -> counters
Sourceval dump_counters : unit Fmt.t
Sourceval reset_counters : unit -> unit
Sourceval inspect : tree -> [ `Contents | `Node of [ `Key | `Map | `Portable_dirty | `Pruned | `Value ] ]
Sourcemodule Private : sig ... end
Sourcetype kinded_key = [
  1. | `Contents of contents_key * metadata
  2. | `Node of node_key
]
Sourceval kinded_key_t : kinded_key Irmin.Type.t
Sourceval key : tree -> kinded_key option
Sourceval find_key : Repo.t -> tree -> kinded_key option Lwt.t
Sourceval of_key : Repo.t -> kinded_key -> tree option Lwt.t
Sourceval shallow : Repo.t -> kinded_key -> tree
Sourceval hash : ?cache:bool -> tree -> hash
Sourcetype kinded_hash = [
  1. | `Contents of hash * metadata
  2. | `Node of hash
]
Sourceval kinded_hash : ?cache:bool -> tree -> kinded_hash
Sourceval of_hash : Repo.t -> kinded_hash -> tree option Lwt.t
Sourcetype verifier_error = [
  1. | `Proof_mismatch of string
  2. | `Stream_too_long of string
  3. | `Stream_too_short of string
]
Sourceval verifier_error_t : verifier_error Irmin.Type.t
Sourceval produce_proof : repo -> kinded_key -> (tree -> (tree * 'a) Lwt.t) -> (Proof.tree Proof.t * 'a) Lwt.t
Sourceval verify_proof : Proof.tree Proof.t -> (tree -> (tree * 'a) Lwt.t) -> (tree * 'a, verifier_error) result Lwt.t
Sourceval hash_of_proof_state : Proof.tree -> kinded_hash
Sourceval produce_stream : repo -> kinded_key -> (tree -> (tree * 'a) Lwt.t) -> (Proof.stream Proof.t * 'a) Lwt.t
Sourceval verify_stream : Proof.stream Proof.t -> (tree -> (tree * 'a) Lwt.t) -> (tree * 'a, verifier_error) result Lwt.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct