package irmin

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

Module Backend.WatchSource

Watch provides helpers to register event notifications on read-write stores.

Sourcemodule type S = sig ... end

The signature for watch helpers.

Sourceval workers : unit -> int

workers () is the number of background worker threads managing event notification currently active.

Sourcetype hook = int -> string -> (string -> unit Lwt.t) -> (unit -> unit Lwt.t) Lwt.t

The type for watch hooks.

Sourceval none : hook

none is the hooks which asserts false.

Sourceval set_listen_dir_hook : hook -> unit

Register a function which looks for file changes in a directory and return a function to stop watching. It is probably best to use Irmin_watcher.hook there. By default, it uses none.

Sourcemodule Make (K : Type.S) (V : Type.S) : S with type key = K.t and type value = V.t

Make builds an implementation of watch helpers.

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