package irmin-server

  1. Overview
  2. Docs
package irmin-server
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Store = Store

Irmin Store type

Tree wraps Store.Tree to avoid encoding/decoding trees more than needed

module Commit : sig ... end

Commits

module Server_info : sig ... end

Used to track information about the server

type context = {
  1. conn : Conn.t;
  2. config : Irmin.Backend.Conf.t;
  3. repo : Store.Repo.t;
  4. mutable watch : Store.watch option;
  5. mutable branch_watch : Store.Backend.Branch.watch option;
}

context is passed to every command as the first argument

module type CMD = sig ... end
type t = (module CMD)

Command type

val name : t -> string

Get the name of a command

val of_name : string -> t

Find a command by name, the name should be lowercase

val commands : (string * t) list

A list of all registered commands

module Commands : sig ... end
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