package irmin-server

  1. Overview
  2. Docs
package irmin-server
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Command.MakeSource

Parameters

module IO : Conn.IO

Signature

Sourcemodule Conn : Conn.S with module IO = IO
Sourcemodule Store = Store

Irmin Store type

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

Sourcemodule Commit : sig ... end

Commits

Sourcemodule Server_info : sig ... end

Used to track information about the server

Sourcetype 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

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

Command type

Sourceval name : t -> string

Get the name of a command

Sourceval of_name : string -> t

Find a command by name, the name should be lowercase

Sourceval commands : (string * t) list

A list of all registered commands

Sourcemodule Commands : sig ... end