package irmin-fs

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

A repo abstraction.

type t = repo

Repo opening and closing functions

val v : Irmin__.Conf.t -> t Lwt.t

v config is a function returning fresh store handles, with the configuration config, which is provided by the backend.

val close : t -> unit Lwt.t

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

Getters from repo to backend store in ro mode

val contents_t : t -> Irmin.Perms.read Contents.t
val node_t : t -> Irmin.Perms.read Node.t
val commit_t : t -> Irmin.Perms.read Commit.t
val config : t -> Irmin__.Conf.t

A getter from repo to backend stores in rw mode.

val branch_t : t -> Branch.t

A branch store getter from repo

OCaml

Innovation. Community. Security.