package irmin-unix

  1. Overview
  2. Docs
On This Page
  1. Unix backends
package irmin-unix
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Irmin_unixSource

Unix backends

This module provides Irmin backends for Unix applications. The currently supported backends are:

  • An in-memory store, internally using hash tables.
  • A file-system backend, using bin_prot to serialize internal structures.
  • A fully compatible, bidirectional encoding of Irmin into Git. You can view and edit your store using both the library and your usual Git tools.
  • The HTTP clients and servers provides a high-level REST API, with 1 RTT for the private and public functions.
Sourceval info : ?author:string -> ('a, Format.formatter, unit, Irmin.Info.f) format4 -> 'a

info fmt () creates a fresh commit info, with the date set to Unix.gettimeoday () and the author built using Unix.gethostname() and Unix.getpid() if author is not provided.

Sourcemodule FS : sig ... end

File system backends, using bin_prot.

Sourcemodule Git : sig ... end

Bidirectional Git backends.

Sourcemodule Http : sig ... end

REST (over HTTP) backend..

Sourceval set_listen_dir_hook : unit -> unit

Install Irmin_watcher.hook as the listen hook for watching changes in directories.

Sourcemodule Graphql : sig ... end
Sourcemodule Cli : sig ... end

CLI commands.

Sourcemodule Resolver : sig ... end

Irmin store resolver.