package irmin-unix

  1. Overview
  2. Docs
package irmin-unix
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = value
val t : t Irmin__.Type.t
type metadata = Metadata.t
val metadata_t : metadata Irmin__.Type.t
type hash = key
val hash_t : hash Irmin__.Type.t
type step = Path.step
val step_t : step Irmin__.Type.t
type value = [
  1. | `Contents of hash * metadata
  2. | `Node of hash
]
val value_t : value 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 : (step * value) Irmin__.Import.Seq.t -> t
val seq : ?offset:int -> ?length:int -> ?cache:bool -> t -> (step * value) Irmin__.Import.Seq.t
val empty : t
val is_empty : t -> bool
val length : t -> int
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
val default : metadata
type proof = [
  1. | `Blinded of hash
  2. | `Inode of int * (int * proof) list
  3. | `Values of (step * value) list
]
val proof_t : proof Irmin__.Type.t
val to_proof : t -> proof
val of_proof : depth:int -> proof -> t option
exception Dangling_hash of {
  1. context : string;
  2. hash : hash;
}
val head : t -> [ `Inode of int * (int * hash) list | `Node of (step * value) list ]
val with_handler : ((expected_depth:int -> hash -> t option) -> expected_depth:int -> hash -> t option) -> t -> 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