package irmin-pack

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type key = key
type t
val t : t Irmin.Type.t
type metadata = Snapshot.metadata
val metadata_t : metadata Irmin.Type.t
type contents_key = key
val contents_key_t : contents_key Irmin.Type.t
type node_key = key
val node_key_t : node_key Irmin.Type.t
type step = Value.step
val step_t : step Irmin.Type.t
type value = [
  1. | `Contents of contents_key * metadata
  2. | `Node of node_key
]
val value_t : value Irmin.Type.t
type hash = hash
val hash_t : hash Irmin.Type.t
val of_list : (step * value) list -> t
val list : ?offset:int -> ?length:int -> ?cache:bool -> t -> (step * value) list
val of_seq : (unit -> (step * value) Stdlib__Seq.node) -> t
val seq : ?offset:int -> ?length:int -> ?cache:bool -> t -> unit -> (step * value) Stdlib__Seq.node
val empty : unit -> t
val is_empty : t -> bool
val hash_exn : ?force:bool -> t -> hash
val clear : t -> unit
val find : ?cache:bool -> t -> step -> value option
val add : t -> step -> value -> t
val remove : t -> step -> t
module Metadata : sig ... end
val with_handler : ((expected_depth:int -> node_key -> t option) -> expected_depth:int -> node_key -> t option) -> t -> t
val head : t -> [ `Inode of int * (int * hash) list | `Node of (step * value) list ]
val merge : contents:contents_key option Irmin.Merge.t -> node:node_key option Irmin.Merge.t -> t Irmin.Merge.t
exception Dangling_hash of {
  1. context : string;
  2. hash : hash;
}
val pred : t -> (step option * [ `Contents of contents_key | `Inode of node_key | `Node of node_key ]) list
val nb_children : t -> int
val of_raw : (expected_depth:int -> key -> Raw.t option) -> Raw.t -> t
val to_raw : t -> Raw.t
val save : ?allow_non_root:bool -> add:(hash -> Raw.t -> key) -> index:(hash -> key option) -> mem:(key -> bool) -> t -> key
val stable : t -> bool
val length : t -> int
val index : depth:int -> step -> int
val integrity_check : t -> bool
module Concrete : sig ... end
val to_concrete : t -> Concrete.t
val of_concrete : Concrete.t -> (t, Concrete.error) Stdlib.result
module Portable : sig ... end
val of_snapshot : Snapshot.inode -> index:(hash -> key) -> (expected_depth:int -> key -> Raw.t option) -> t